Email Campaign
Overview
The Email Campaign endpoint allows you to manage your Email Campaigns, by creating new Campaigns, or by requesting information about or updating existing Campaigns. The endpoint supports Campaigns that use a Messaging table as their data source, and Campaigns that use the Engagement Data Platform (EDP) as their data source.
For more details on how to set up an Email Campaign API request, please see the Email Campaign API Technical Guide.
Email Campaigns can also be created from the Campaign screen, or from the New Item screen.
-
Endpoint (North America): https://api.eccmp.com/services2/api/EmailCampaign
-
Endpoint (Europe): https://api.ccmp.eu/services2/api/EmailCampaign
-
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/EmailCampaign
GET Method
The Email Campaign endpoint supports the following GET operation. This endpoint allows you to retrieve information about a specified Email Campaign by providing its Object Reference ID.
Note: This endpoint works only for Campaigns in the email channel; the endpoint can't retrieve information about Campaigns in other channels.
Click hereClick here to see a sample response message in JSON format.
{
"campId": 23448,
"campName": "Summer trigger campaign",
"custId": 123
"entityId": 100,
"channelTypeId": "EMAIL",
"typeId": "TRIGGERED",
"campTriggers": [
{
"typeId": "FORM_SUBMISSION"
}
],
"contBodies": [
{
"campId": 23448,
"type": "HTML",
"usageMask": "ALL_EMAIL_STYLE_USAGE_MASK",
"body": "Email message content goes here."
}
],
"linkTrackingUsageMask": "HTML_AND_TEXT",
"linkTrackingDomainId": 1506,
"campParam": {
"campId": 23448,
"shortenLinksFlag": 0,
"carryOverToNextDayFlag": 1,
"stopNightDeliveryFlag": 0,
"ignoreConfirmationFlag": 0,
"sendSchedule": {
"startTime": "2017-07-31T00:00:00",
"timeZone": "Central_Standard_Time",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 1
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"excludeTimeBefore": "2000-01-01T00:00:01",
"excludeTimeAfter": "2000-01-01T23:59:59"
}
}
},
"queueSchedule": {
"timeZone": "Central_Standard_Time",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 4
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"excludeTimeBefore": "2000-01-01T00:00:01",
"excludeTimeAfter": "2000-01-01T23:59:59"
}
}
}
},
"campStepProcedures": [],
"campToList": {
"campId": 23448
},
"campLimit": {
"campId": 23448
},
"campMetaParams": [
{
"campId": 23448,
"optionId": 9,
"selectionId": 1,
"campMetaParamOptionSelection": {
"selectionId": 1,
"optionId": 9,
"stringVal": "Promos"
}
},
{
"campId": 23448,
"optionId": 41,
"stringVal": "summer"
}
],
"campReviewFlags": {
"campId": 23448,
"contCalculationFlag": 0,
"personalizationFlag": 0,
"sendingFlag": 1
},
"emailMsgTemplate": {
"campId": 23448,
"fromName": "NY5 CMS/DMS 4",
"toName": "{(name_first)} {(name_last)}",
"toAddressPropId": 1150,
"fromAddressId": 3,
"subject": "Summer is here!",
"codePageId": 65001,
"vmtaPoolId": 100323,
"proofSubjectPrefix": "PROOF"
},
"obj": {
"obj_id": 45993,
"display_name": "Summer trigger campaign",
"type_id": "CampaignEmail",
"ref_id": 23448,
"parent_obj_id": 37249,
"eligibility_status_id": "READY"
}
}
POST Method
The Email Campaign endpoint supports the following POST operation. This endpoint allows you to create a new Email Campaign by providing the following basic information:
-
Your Customer ID.
-
The Entity ID of the desired table.
-
The name of the new Campaign.
-
The Folder ID of the folder where you want to save the new Campaign.
-
The type of Campaign -- Regular One-off, Date-triggered, or Event-triggered.
-
Additional supporting assets (Filter, Seed List, Exclusion List, etc.)
-
The email header information (from address, to address, subject line, etc.).
-
Campaign schedule information.
-
Message content.
-
For a Load and Send Campaign -- the Load and Send import file, or folder location.
-
For a Campaign that uses EDP as its data source -- the Segment ID of the Campaign's Segment.
Click hereClick here to see a sample request message in JSON format.
{
"custId": 394,
"entityId": 100,
"typeId": "CALCULATED",
"toFilterId": 29094,
"obj": {
"display_name": "Test Date Calculated Email Campaign",
"parent_obj_id": 37249
},
"contBodies": [
{
"type": "HTML",
"usageMask": "ALL_EMAIL_STYLE_USAGE_MASK",
"body": "HTML content goes here."
},
{
"type": "TEXT",
"usageMask": "EMAIL, WEB, REPORT_SOCIAL_MASK",
"body": "Plain text content goes here."
}
],
"emailMsgTemplate": {
"fromName": "Cheetah Digital",
"toName": "{(name_first)} {(name_last)}",
"toAddressPropId": 1150,
"fromAddressId": 1005,
"codePageId": 65001,
"subject": "Hello, {(name_first)}!"
},
"campParam": {
"sendSchedule": {
"startTime": "2018-03-19T09:00:00",
},
"queueSchedule": {
"startTime": "2018-03-19T09:00:00",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 1
},
"timeFrequency": {
"runAtTime": "2000-01-01T09:00:00"
}
}
}
}
PUT Method
The Email Campaign endpoint supports the following PUT operation. This endpoint allows you to submit modifications to an existing Email Campaign. The request message must include the Campaign's Object Reference ID, and the desired changes. Using this endpoint, you can change just about any aspect of the Campaign, including its name, subject line, message content, schedule, etc.
In addition, you can use the PUT method to execute a process for this Campaign, such as send proofs, run audits, or launch the Campaign, for example.
DELETE Method
The Email Campaign endpoint supports a DELETE operation that will delete the specified Campaign. You must provide the Object Reference ID for the desired Campaign.
Note: Deleted Campaigns are moved to the Recycle Bin.
Back to API Category - Campaign Management