Trigger campaigns using APIs (1.0 - GA)

Download OpenAPI specification:Download

Interactive Message Execution API helps you with messaging capabilities. Using this REST API, you can send marketing or transactional messages using a Campaign Id using Email, SMS and Push channels. You will need the Campaign ID to send message using API.

Related documentation:
To learn more about the API-triggered Campaign creation flow and supported channels, refer to product documentation here

Code examples:
Examples of how to trigger Campaigns using various channels are available in this page.

API path:
Base path for Interactive Message Execution APIs: https://platform.adobe.io/ajo/im/executions
Example of a complete path: https://platform.adobe.io/ajo/im/executions/unitary


Required headers:
All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.

execution

Trigger an unitary message execution.

SecurityimsUserToken
Request
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Request Body schema: application/json
required
requestId
required
string

the Unique Request Identifier

campaignId
required
string

the Campaign Identifier

required
Array of any (recipients) [ 1 .. 20 ] items

the list of recipients

Responses
202

Accepted

400

Bad Request

401

Unauthorized

post/im/executions/unitary
Request samples
application/json
{
  • "requestId": "request-12345",
  • "campaignId": "campaign-12345",
  • "recipients": [
    ]
}
Response samples
application/json
{
  • "executionId": "UMA-00859153",
  • "requestId": "REQ-80940549",
  • "createdAt": "2016-08-29T09:12:33.001Z",
  • "createdBy": "5d1281e6d935456i4273@AdobeId",
  • "modifiedAt": "2016-08-29T09:12:33.001Z",
  • "modifiedBy": "4c0190e5d702748f0931@AdobeId"
}

Trigger an Audience Based Message execution.

SecurityimsUserToken
Request
header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Request Body schema: application/json
required
requestId
string

the Unique Request Identifier

campaignId
required
string

the Campaign Identifier

object (context)

the context data used for dynamic variable substitution in message content

Responses
202

Accepted

400

Bad Request

401

Unauthorized

post/im/executions/audience
Request samples
application/json
{
  • "requestId": "request-12345",
  • "campaignId": "campaign-12345",
  • "context": {
    }
}
Response samples
application/json
{
  • "executionId": "UMA-00859153",
  • "requestId": "REQ-80940549",
  • "createdAt": "2016-08-29T09:12:33.001Z",
  • "createdBy": "5d1281e6d935456i4273@AdobeId",
  • "modifiedAt": "2016-08-29T09:12:33.001Z",
  • "modifiedBy": "4c0190e5d702748f0931@AdobeId"
}

Get Execution Status for Audience Based Message executions.

SecurityimsUserToken
Request
path Parameters
executionId
required
string

execution id

header Parameters
x-api-key
required
string

The API key belonging to the calling client.

x-request-id
string

A unique id generated by Adobe.io.

x-gw-ims-org-id
required
string

The ims org id for which the action is being taken.

x-sandbox-name
required
string

Provides the platform Sandbox Name

Responses
200

OK

401

Unauthorized

404

Not Found

get/im/executions/audience/{executionId}
Response samples
application/json
{
  • "executionId": "CMA-09378831",
  • "audienceId": "audienceId-12345",
  • "campaignId": "campaignId-12345",
  • "status": "Succeeded",
  • "targetedProfileCount": "2",
  • "createdAt": "2016-08-29T09:12:33.001Z"
}