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.
Accepted
Bad Request
Unauthorized
{- "requestId": "request-12345",
- "campaignId": "campaign-12345",
- "recipients": [
- {
- "type": "aep",
- "userId": "AEP-ProfileID-12345",
- "namespace": "email",
- "channelData": {
- "emailAddress": "customer123@example.com",
- "mobilePhoneNumber": "111-111-1111"
}, - "profile": {
- "person": {
- "name": {
- "firstName": "Jane",
- "lastName": "Doe"
}
}
}, - "context": {
- "product": "Gaming Laptop"
}
}
]
}
{- "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"
}
Accepted
Bad Request
Unauthorized
{- "requestId": "request-12345",
- "campaignId": "campaign-12345",
- "context": {
- "product": "Gaming Laptop"
}
}
{- "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"
}
OK
Unauthorized
Not Found
{- "executionId": "CMA-09378831",
- "audienceId": "audienceId-12345",
- "campaignId": "campaignId-12345",
- "status": "Succeeded",
- "targetedProfileCount": "2",
- "createdAt": "2016-08-29T09:12:33.001Z"
}