Email Cell Campaign
Overview
The Email Cell Campaign endpoint allows you to view and edit the individual cells within a split cell Email Campaign.
Please note that you can't create new cells using this endpoint, and you can't change the split type (by percent, by amount, etc.). To create cells, or to configure the split type, you must use the Campaign screen within the application.
For more details on how to set up an Email Cell Campaign API request, please see the Email Cell Campaign API Technical Guide.
Endpoint (North America):
https://api.eccmp.com/services2/api/EmailCampaignCell
https://api.eccmp.com/services2/api/EmailCampaignCell/campId/{id}
Endpoint (Europe):
https://api.ccmp.eu/services2/api/EmailCampaignCell
https://api.ccmp.eu/services2/api/EmailCampaignCell/campId/{id}
Endpoint (Japan):
https://api.marketingsuite.jp/services2/EmailCampaignCell
https://api.marketingsuite.jp/services2/EmailCampaignCell/campId/{id}
GET Method
The Email Cell Campaign endpoint supports the following GET operations.
Retrieve List of Sub-Cells
This endpoint allows you to retrieve a list of all the sub-cells beneath a specified Campaign or "parent" cell. You must provide the Object Reference ID for either the desired Campaign or parent cell.
If you specify a Campaign, the response message will list every child cell, grandchild cell, etc. within the entire Campaign. If you specify a "parent" cell, the response message will list only the child cells beneath that parent cell.
Note: This endpoint works only for Campaigns in the email channel; the endpoint can't retrieve information about Campaigns in other channels.
The response message includes information about each sub-cell, such as its Object Reference ID, Cell Code, split type, etc.
Click hereClick here to see a sample response message in JSON format.
[
{
"childCampId": 53,
"parentCampId": 52,
"seq": 0,
"cellCode": "Child Cell A",
"splitTypeId": 10,
"filterOperator": "AND",
"orderByDirection": "ASC",
"remainderFlag": 0
},
{
"childCampId": 54,
"parentCampId": 52,
"seq": 1,
"cellCode": "Child Cell B",
"filterOperator": "AND",
"orderByDirection": "ASC",
"remainderFlag": 0
},
{
"childCampId": 55,
"parentCampId": 53,
"seq": 0,
"cellCode": "Child Cell A_1",
"splitTypeId": 10,
"amount": 1,
"orderByDirection": "ASC",
"remainderFlag": 0
},
{
"childCampId": 70,
"parentCampId": 53,
"seq": 1,
"cellCode": "Child Cell A_REMAINDER",
"orderByDirection": "ASC",
"remainderFlag": 1
},
{
"childCampId": 56,
"parentCampId": 55,
"seq": 0,
"cellCode": "Child Cell A_1_1",
"amount": 1,
"remainderFlag": 0
}
]
Retrieve a Sub-Cell
This endpoint allows you to retrieve information about a single cell within a single specified Campaign. You must provide the Object Reference IDs for both the Campaign and the cell.
Note: This endpoint works only for Campaigns in the email channel; the endpoint can't retrieve information about Campaigns in other channels.
The response message includes the same information as the Email Campaign API endpoint, including the cell's name, type, content, schedule, and associated assets (Filter, Seed List, Exclusion List, etc.).
Click hereClick here to see a sample response message in JSON format.
{
"campId": 54,
"campName": "Campaign Child Cell A",
"custId": 100,
"entityId": 100,
"channelTypeId": "EMAIL",
"typeId": "REGULAR",
"toFilterId": 23,
"contBodies": [
{
"campId": 54,
"type": "HTML",
"usageMask": "ALL_EMAIL_STYLE_USAGE_MASK"
}
],
"linkTrackingUsageMask": "HTML_AND_TEXT",
"linkTrackingDomainId": 2,
"campParam": {
"campId": 54,
"carryOverToNextDayFlag": 1,
"stopNightDeliveryFlag": 0,
"sendSchedule": {
"timeZone": "Singapore_Standard_Time",
"dayFrequency": {
"frequencyType": "Daily",
"daysInterval": 1
},
"timeFrequency": {
"timeIntervalType": "MutipleTimesADay",
"multipleTimesInterval": {
"excludeTimeBefore": "2000-01-01T00:00:01",
"excludeTimeAfter": "2000-01-01T23:59:59"
}
}
}
},
"campStepProcedures": [],
"campToList": {
"campId": 54
},
"campLimit": {
"campId": 54
},
"campReviewFlags": {
"campId": 54,
"contCalculationFlag": 0,
"personalizationFlag": 0,
"sendingFlag": 1
},
"emailMsgTemplate": {
"campId": 54,
"subject": "Subject line testing",
"vmtaPoolId": 1,
"proofSubjectPrefix": "PROOF"
},
"obj": {
"obj_id": 11538,
"display_name": "Campaign Child Cell A",
"type_id": "CampCell",
"hidden_flag": 1,
"ref_id": 54,
"parent_obj_id": 11440,
"eligibility_status_id": "READY"
}
}
PUT Method
The Email Cell Campaign endpoint supports the following PUT operation. This endpoint allows you to submit modifications to a cell. You must provide the Object Reference IDs for both the Campaign and the cell, along with the desired changes. Using this endpoint, you can change just about any aspect of the cell, including its name, subject line, message content, schedule, etc.
Click hereClick here to see a sample request message in JSON format.
{
"custId": 100,
"entityId": 100,
"channelTypeId": "EMAIL",
"typeId": "REGULAR",
"contBodies": [
{
"type": "HTML",
"usageMask": "ALL_EMAIL_STYLE_USAGE_MASK",
"body": "HTML content goes here"
}
],
"linkTrackingUsageMask": "HTML_AND_TEXT",
"campParam": {
"sendSchedule": {
"timeZone": "Pacific_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": "Pacific_Standard_Time"
}
},
"campReviewFlags": {
"contCalculationFlag": 0,
"personalizationFlag": 0,
"sendingFlag": 1
},
"obj": {
"display_name": "Split Cells_1",
"parent_obj_id": 11440
}
}
Back to API Category - Campaign Management