Email Campaign Trigger
Overview
The Email Campaign Trigger endpoint is sometimes referred to as the "instant trigger" endpoint, because it will deploy a Campaign upon receipt of the API message, prior to loading the database. Therefore, all of the information needed for the Campaign content, such as email address and any Personalization fields, must be contained within the message payload. Following the Campaign deployment, the system will load specified data fields from the message into your database. If the fields posted match what's in the database, the system will try to insert / update these records after the Campaign is deployed. You can also submit additional fields (called "Record Metadata") that are not in your database, and reference them within your email message Personalization; these fields will not be added to the database.
This endpoint requires authentication through OAuth 2.0, and supports JSON and XML.
This endpoint supports only a single table insert, not a hierarchical data insert like the Sequential Event Trigger or the Advanced Event Trigger endpoints. Also, you can submit only one record at a time.
-
Endpoint (North America): https://api.eccmp.com/services2/api/EmailCampaign/Trigger
-
Endpoint (Europe): https://api.ccmp.eu/services2/api/EmailCampaign/Trigger
-
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/EmailCampaign/Trigger
For more details on how to set up an Email Campaign Trigger API request, please see the Email Campaign Trigger API Technical Guide.
The following diagram depicts the processing flow for deploying a Campaign via the Email Campaign Trigger endpoint.
Pre-requisites
The Email Campaign Trigger endpoint requires the following:
-
Data Map -- The Data Map provides data handling instructions, such as where to store the inbound data contained within the API request message, and whether this data should be used to update existing records and / or create new records.
-
API Post -- The API Post serves as the triggering mechanism for the Campaign. The API Post must contain all expected fields in the request message. In addition, the "REST API Only" check box and the "Trigger" check box should both be checked. You must also publish the API Post to make it available.
-
Campaign -- You must define and launch an Event-triggered Campaign that uses the above API Post as the event trigger.
POST Method
The Email Campaign Trigger endpoint supports a POST operation. This operation is intended to trigger the deployment of an Event-triggered Campaign by providing the following information:
-
The Form ID of the API Post.
-
All of the information needed for the message content (email address, any Personalization fields) sent as Name / Value pairs. For the field names, be sure to use the system "Column Name," and not the "Display Name."
Click hereClick here to see a sample request message in JSON format.
{
"recipient": {
"apiPostId": "2515",
"data":[
{
"name": "email",
"value": "john.doe@cheetahdigital.com"
},
{
"name": "name_first",
"value": "John"
},
{
"name": "name_last",
"value": "Doe"
}
]
}
}
Click hereClick here to see a sample response message in JSON format.
{
"sentMessages": [
{
"campaignId": 23453,
"messageId": 24936568,
"sendTime": "2017-07-25T20:40:34.4274817Z"
}
]
}
Back to API Category - Campaign Deployment