Jump to

• Request
• Response

Create a campaign field.

post

/api/rest/2.0/assets/campaign/field

Creates a campaign field that matches the criteria specified by the request body.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the campaign field to be created.

Root Schema : CampaignField

Type: object

Title: CampaignField

Show Source

• createdAt: string
  Read Only: true

  CampaignField_Field_CreatedAt_Description
• createdBy: string
  Read Only: true

  CampaignField_Field_CreatedBy_Description
• currentStatus: string
  CampaignField_Field_Status_Description
• dataType: string
  The campaign field's data type. The options are: date, numeric, and text.
• depth: string
  Read Only: true

  CampaignField_Field_InternalDepth_Description
• description: string
  CampaignField_Field_Description_Description
• displayIndex: string
  The campaign field's display index.
• displayType: string
  The campaign field's display type. The options are: multiSelect, singleSelect, and text.
• folderId: string
  Read Only: true

  CampaignField_Field_FolderId_Description
• id: string
  Read Only: true

  CampaignField_Field_InternalId_Description
• isReadOnly: string
  Whether or not the campaign field is read only.
• isRequired: string
  Whether or not the campaign field is required.
• isSystem: string
  Whether or not the campaign field is a system field.
• name: string
  CampaignField_Field_Name_Description
• optionListId: string
  The id of the associated option list.
• permissions: array permissions
  CampaignField_Field_Permissions_Description
• scheduledFor: string
  Read Only: true

  CampaignField_Field_ScheduledFor_Description
• sourceTemplateId: string
  CampaignField_Field_SourceTemplateId_Description
• type: string
  CampaignField_Field_Type_Description
• updatedAt: string
  Read Only: true

  CampaignField_Field_UpdatedAt_Description
• updatedBy: string
  Read Only: true

  CampaignField_Field_UpdatedBy_Description

{
    "title":"CampaignField",
    "properties":{
        "type":{
            "type":"string",
            "description":"CampaignField_Field_Type_Description"
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_InternalId_Description"
        },
        "currentStatus":{
            "type":"string",
            "description":"CampaignField_Field_Status_Description"
        },
        "name":{
            "type":"string",
            "description":"CampaignField_Field_Name_Description"
        },
        "description":{
            "type":"string",
            "description":"CampaignField_Field_Description_Description"
        },
        "permissions":{
            "type":"array",
            "description":"CampaignField_Field_Permissions_Description",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_FolderId_Description"
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"CampaignField_Field_SourceTemplateId_Description"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_CreatedBy_Description"
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_CreatedAt_Description"
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_UpdatedBy_Description"
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_UpdatedAt_Description"
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_ScheduledFor_Description"
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_InternalDepth_Description"
        },
        "displayType":{
            "type":"string",
            "description":"The campaign field's display type. The options are: multiSelect, singleSelect, and text."
        },
        "dataType":{
            "type":"string",
            "description":"The campaign field's data type. The options are: date, numeric, and text."
        },
        "isRequired":{
            "type":"string",
            "description":"Whether or not the campaign field is required."
        },
        "isReadOnly":{
            "type":"string",
            "description":"Whether or not the campaign field is read only."
        },
        "optionListId":{
            "type":"string",
            "description":"The id of the associated option list."
        },
        "isSystem":{
            "type":"string",
            "description":"Whether or not the campaign field is a system field."
        },
        "displayIndex":{
            "type":"string",
            "description":"The campaign field's display index."
        }
    }
}

Nested Schema : permissions

Type: array

CampaignField_Field_Permissions_Description

Show Source

• Array of: string

{
    "type":"array",
    "description":"CampaignField_Field_Permissions_Description",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success

Body ()

Root Schema : CampaignField

Type: object

Title: CampaignField

Show Source

• createdAt: string
  Read Only: true

  CampaignField_Field_CreatedAt_Description
• createdBy: string
  Read Only: true

  CampaignField_Field_CreatedBy_Description
• currentStatus: string
  CampaignField_Field_Status_Description
• dataType: string
  The campaign field's data type. The options are: date, numeric, and text.
• depth: string
  Read Only: true

  CampaignField_Field_InternalDepth_Description
• description: string
  CampaignField_Field_Description_Description
• displayIndex: string
  The campaign field's display index.
• displayType: string
  The campaign field's display type. The options are: multiSelect, singleSelect, and text.
• folderId: string
  Read Only: true

  CampaignField_Field_FolderId_Description
• id: string
  Read Only: true

  CampaignField_Field_InternalId_Description
• isReadOnly: string
  Whether or not the campaign field is read only.
• isRequired: string
  Whether or not the campaign field is required.
• isSystem: string
  Whether or not the campaign field is a system field.
• name: string
  CampaignField_Field_Name_Description
• optionListId: string
  The id of the associated option list.
• permissions: array permissions
  CampaignField_Field_Permissions_Description
• scheduledFor: string
  Read Only: true

  CampaignField_Field_ScheduledFor_Description
• sourceTemplateId: string
  CampaignField_Field_SourceTemplateId_Description
• type: string
  CampaignField_Field_Type_Description
• updatedAt: string
  Read Only: true

  CampaignField_Field_UpdatedAt_Description
• updatedBy: string
  Read Only: true

  CampaignField_Field_UpdatedBy_Description

{
    "title":"CampaignField",
    "properties":{
        "type":{
            "type":"string",
            "description":"CampaignField_Field_Type_Description"
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_InternalId_Description"
        },
        "currentStatus":{
            "type":"string",
            "description":"CampaignField_Field_Status_Description"
        },
        "name":{
            "type":"string",
            "description":"CampaignField_Field_Name_Description"
        },
        "description":{
            "type":"string",
            "description":"CampaignField_Field_Description_Description"
        },
        "permissions":{
            "type":"array",
            "description":"CampaignField_Field_Permissions_Description",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_FolderId_Description"
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"CampaignField_Field_SourceTemplateId_Description"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_CreatedBy_Description"
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_CreatedAt_Description"
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_UpdatedBy_Description"
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_UpdatedAt_Description"
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_ScheduledFor_Description"
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"CampaignField_Field_InternalDepth_Description"
        },
        "displayType":{
            "type":"string",
            "description":"The campaign field's display type. The options are: multiSelect, singleSelect, and text."
        },
        "dataType":{
            "type":"string",
            "description":"The campaign field's data type. The options are: date, numeric, and text."
        },
        "isRequired":{
            "type":"string",
            "description":"Whether or not the campaign field is required."
        },
        "isReadOnly":{
            "type":"string",
            "description":"Whether or not the campaign field is read only."
        },
        "optionListId":{
            "type":"string",
            "description":"The id of the associated option list."
        },
        "isSystem":{
            "type":"string",
            "description":"Whether or not the campaign field is a system field."
        },
        "displayIndex":{
            "type":"string",
            "description":"The campaign field's display index."
        }
    }
}

Nested Schema : permissions

Type: array

CampaignField_Field_Permissions_Description

Show Source

• Array of: string

{
    "type":"array",
    "description":"CampaignField_Field_Permissions_Description",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.

Back to Top