• items(optional): array items

{
    "title":"EMD Campaigns",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/create-update-retrieve-campaign-response"
            }
        }
    }
}

• Array of: object Campaign
  Title: Campaign

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/create-update-retrieve-campaign-response"
    }
}

• appName(optional): string
  Name of the app associated with the campaign. Only applicable to Message Center campaigns
• attachmentPaths(optional): array attachmentPaths
  Attachments for the campaign.
• autoCloseOption(optional): string
  Allowed Values: [ "NO_AUTO_CLOSE", "AUTO_CLOSE_X_DAYS_AFTER_LAUNCH", "AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE", "AUTO_CLOSE_ON_DATE" ]

  Auto close options for this campaign.
• autoCloseValue(optional): string
  This represents number of days if autoCloseOption is AUTO_CLOSE_X_DAYS_AFTER_LAUNCH or AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE.This represents date if autoCloseOption is AUTO_CLOSE_ON_DATE.
• bccEmail(optional): string
  Bcc Email Address for the campaign.
• campaignStatus(optional): string
  Allowed Values: [ "NONE", "DRAFT", "ACTIVE", "CLOSED" ]

  Status of the campaign.
• campaignVariables(optional): object campaignVariables
  Additional Properties Allowed: additionalProperties

  Map of Name and value of campaign variables which are used as default values for text replacement.
• closedCampaignURL(optional): string
  The URL to redirect to if a recipient clicks on a link of an already closed campaign.
• description(optional): string
  Description of the campaign.
• destinationMessageCenter(optional): string
  Destination Message Center for the campaign. Only applicable to Message Center campaigns
• enableExternalTracking(optional): boolean
  Enable to use third-party web analytics service that use tracking parameters appended to the URLs.
• enableLinkTracking(optional): boolean
  Enable to track the links in a campaign.
• externalCampaignCode(optional): string
  External campaign code.
• externalTrackingParams(optional): object externalTrackingParams
  Additional Properties Allowed: additionalProperties

  Map of Name and value of external tracking parameters.
• filterPaths(optional): array filterPaths
  Paths of filter to be used for this campaign. This can be used to select a group of customers to receive specific messages. Either standard filter or SQL View can be specified.
• folderName(optional): string
  Folder name for the campaign.
• fromEmail(optional): string
  From Email Address for the campaign.
• fromName(optional): string
  From Name for the campaign.
• htmlMessagePath(optional): string
  HTML message folder and path for the campaign.
• id(optional): string
  ID of the campaign.
• linkTablePath(optional): string
  Link table to be included in this campaign.
• listName(optional): string
  Profile list name which contains the audience for this campaign.
• locale(optional): string
  The default recipient locale for this account.
• marketingProgram(optional): string
  Type of marketing program. The values are defined by the Account Administrator.
• marketingStrategy(optional): string
  Type of marketing strategy. The values are defined by the Account Administrator.
• name(optional): string
  Name of the campaign.
• proofListPath(optional): string
  Before sending the campaign to customers, send it to proof list for testing.
• purpose(optional): string
  Allowed Values: [ "PROMOTIONAL", "TRANSACTIONAL" ]

  Purpose of the campaign.
• refiningDataSourcePath(optional): string
  Path of additional data sources to be used for this campaign.
• replyToEmail(optional): string
  Reply To Email Address for the campaign.
• salesForceCampaignId(optional): string
  Salesforce campaign id.
• seedListPath(optional): string
  Seed lists recipients receive the campaign when it is launched but are excluded from live report.
• segmentPaths(optional): array segmentPaths
  Segmentations are used to divide a list into segments using attributes of a profile extension table or profile list.
• segmentTrackingColumnName(optional): string
  Column name for tracking segments.
• sendTextIfHTMLUnknown(optional): boolean
  If HTML ability is unknown, this option allows sending MIME messages to ensure message text is displayed correctly.
• subject(optional): string
  Campaign Subject.
• supplementaryCampaignDataSourcePaths(optional): array supplementaryCampaignDataSourcePaths
  Supplementary data sources can be used for inclusions or exclusions of the audience.
• supplementaryProofDataSourcePaths(optional): array supplementaryProofDataSourcePaths
  Supplementary proof data sources can be used for inclusions or exclusions from proof list.
• supplementarySeedDataSourcePaths(optional): array supplementarySeedDataSourcePaths
  Supplementary seed data sources can be used for inclusions or exclusions from seed list.
• suppressionListPaths(optional): array suppressionListPaths
  This is used to exclude recipients from data sources.
• textMessagePath(optional): string
  Text message folder and path for the campaign.
• trackConversions(optional): boolean
  This applies only when link tracking is enabled for the campaign. This option can be used to record conversion when clicking a link and following through a specific web page.
• trackHTMLOpens(optional): boolean
  Enable tracking when each recipient with HTML capability opened the email.
• type(optional): string
  Allowed Values: [ "EMAIL", "PUSH", "SMS", "MMS", "PUSHIOCAMPAIGN" ]

  Type of the campaign. It can be EMAIL or PUSH or SMS or MMS or PUSHIOCAMPAIGN.
• unsubscribeFormName(optional): string
  Form name to be used for unsubscribing..
• unsubscribeOption(optional): string
  Allowed Values: [ "NO_OPTOUT_BUTTON", "OPTOUT_SINGLE_CLICK", "OPTOUT_FORM" ]

  The unsubscribe option for this campaign.
• useUTF8(optional): boolean
  Use UTF8 encoding for messages.

{
    "type":"object",
    "title":"Campaign",
    "properties":{
        "autoCloseOption":{
            "description":"Auto close options for this campaign.",
            "enum":[
                "NO_AUTO_CLOSE",
                "AUTO_CLOSE_X_DAYS_AFTER_LAUNCH",
                "AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE",
                "AUTO_CLOSE_ON_DATE"
            ],
            "type":"string"
        },
        "unsubscribeOption":{
            "description":"The unsubscribe option for this campaign.",
            "enum":[
                "NO_OPTOUT_BUTTON",
                "OPTOUT_SINGLE_CLICK",
                "OPTOUT_FORM"
            ],
            "type":"string"
        },
        "campaignStatus":{
            "description":"Status of the campaign.",
            "enum":[
                "NONE",
                "DRAFT",
                "ACTIVE",
                "CLOSED"
            ],
            "type":"string"
        },
        "bccEmail":{
            "description":"Bcc Email Address for the campaign.",
            "type":"string"
        },
        "linkTablePath":{
            "description":"Link table to be included in this campaign.",
            "type":"string"
        },
        "marketingProgram":{
            "description":"Type of marketing program. The values are defined by the Account Administrator.",
            "type":"string"
        },
        "segmentPaths":{
            "description":"Segmentations are used to divide a list into segments using attributes of a profile extension table or profile list.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "refiningDataSourcePath":{
            "description":"Path of additional data sources to be used for this campaign.",
            "type":"string"
        },
        "proofListPath":{
            "description":"Before sending the campaign to customers, send it to proof list for testing.",
            "type":"string"
        },
        "attachmentPaths":{
            "description":"Attachments for the campaign.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "htmlMessagePath":{
            "description":"HTML message folder and path for the campaign.",
            "type":"string"
        },
        "fromEmail":{
            "description":"From Email Address for the campaign.",
            "type":"string"
        },
        "id":{
            "description":"ID of the campaign.",
            "type":"string"
        },
        "listName":{
            "description":"Profile list name which contains the audience for this campaign.",
            "type":"string"
        },
        "useUTF8":{
            "description":"Use UTF8 encoding for messages.",
            "type":"boolean"
        },
        "suppressionListPaths":{
            "description":"This is used to exclude recipients from data sources.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "replyToEmail":{
            "description":"Reply To Email Address for the campaign.",
            "type":"string"
        },
        "segmentTrackingColumnName":{
            "description":"Column name for tracking segments.",
            "type":"string"
        },
        "filterPaths":{
            "description":"Paths of filter to be used for this campaign. This can be used to select a group of customers to receive specific messages. Either standard filter or SQL View can be specified.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"Name of the campaign.",
            "type":"string"
        },
        "locale":{
            "description":"The default recipient locale for this account.",
            "type":"string"
        },
        "supplementarySeedDataSourcePaths":{
            "description":"Supplementary seed data sources can be used for inclusions or exclusions from seed list.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "textMessagePath":{
            "description":"Text message folder and path for the campaign.",
            "type":"string"
        },
        "sendTextIfHTMLUnknown":{
            "description":"If HTML ability is unknown, this option allows sending MIME messages to ensure message text is displayed correctly.",
            "type":"boolean"
        },
        "subject":{
            "description":"Campaign Subject.",
            "type":"string"
        },
        "enableExternalTracking":{
            "description":"Enable to use third-party web analytics service that use tracking parameters appended to the URLs.",
            "type":"boolean"
        },
        "salesForceCampaignId":{
            "description":"Salesforce campaign id.",
            "type":"string"
        },
        "autoCloseValue":{
            "description":"This represents number of days if autoCloseOption is AUTO_CLOSE_X_DAYS_AFTER_LAUNCH or AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE.This represents date if autoCloseOption is AUTO_CLOSE_ON_DATE.",
            "type":"string"
        },
        "trackConversions":{
            "description":"This applies only when link tracking is enabled for the campaign. This option can be used to record conversion when clicking a link and following through a specific web page.",
            "type":"boolean"
        },
        "campaignVariables":{
            "description":"Map<String, String> of Name and value of campaign variables which are used as default values for text replacement.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "type":{
            "description":"Type of the campaign. It can be EMAIL or PUSH or SMS or MMS or PUSHIOCAMPAIGN. ",
            "enum":[
                "EMAIL",
                "PUSH",
                "SMS",
                "MMS",
                "PUSHIOCAMPAIGN"
            ],
            "type":"string"
        },
        "folderName":{
            "description":"Folder name for the campaign.",
            "type":"string"
        },
        "marketingStrategy":{
            "description":"Type of marketing strategy. The values are defined by the Account Administrator.",
            "type":"string"
        },
        "externalTrackingParams":{
            "description":"Map<String, String> of Name and value of external tracking parameters.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "externalCampaignCode":{
            "description":"External campaign code.",
            "type":"string"
        },
        "unsubscribeFormName":{
            "description":"Form name to be used for unsubscribing..",
            "type":"string"
        },
        "seedListPath":{
            "description":"Seed lists recipients receive the campaign when it is launched but are excluded from live report.",
            "type":"string"
        },
        "supplementaryProofDataSourcePaths":{
            "description":"Supplementary proof data sources can be used for inclusions or exclusions from proof list.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "closedCampaignURL":{
            "description":"The URL to redirect to if a recipient clicks on a link of an already closed campaign.",
            "type":"string"
        },
        "description":{
            "description":"Description of the campaign.",
            "type":"string"
        },
        "enableLinkTracking":{
            "description":"Enable to track the links in a campaign.",
            "type":"boolean"
        },
        "supplementaryCampaignDataSourcePaths":{
            "description":"Supplementary data sources can be used for inclusions or exclusions of the audience.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "fromName":{
            "description":"From Name for the campaign.",
            "type":"string"
        },
        "purpose":{
            "description":"Purpose of the campaign.",
            "enum":[
                "PROMOTIONAL",
                "TRANSACTIONAL"
            ],
            "type":"string"
        },
        "trackHTMLOpens":{
            "description":"Enable tracking when each recipient with HTML capability opened the email.",
            "type":"boolean"
        },
        "appName":{
            "description":"Name of the app associated with the campaign. Only applicable to Message Center campaigns",
            "type":"string"
        },
        "destinationMessageCenter":{
            "description":"Destination Message Center for the campaign. Only applicable to Message Center campaigns",
            "type":"string"
        }
    }
}

• Array of: string

{
    "description":"Attachments for the campaign.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• string

{
    "description":"Map<String, String> of Name and value of campaign variables which are used as default values for text replacement.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• string

{
    "description":"Map<String, String> of Name and value of external tracking parameters.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"Paths of filter to be used for this campaign. This can be used to select a group of customers to receive specific messages. Either standard filter or SQL View can be specified.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"Segmentations are used to divide a list into segments using attributes of a profile extension table or profile list.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"Supplementary data sources can be used for inclusions or exclusions of the audience.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"Supplementary proof data sources can be used for inclusions or exclusions from proof list.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"Supplementary seed data sources can be used for inclusions or exclusions from seed list.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

{
    "description":"This is used to exclude recipients from data sources.",
    "type":"array",
    "items":{
        "type":"string"
    }
}