Skip to main content

POST /automations/invoke

POSThttps://api.courier.com/automations/invoke
Invoke an ad hoc automation run.
BODY PARAM
automationobjectrequired
stepsarrayrequired
cancelation_tokenoneOf
string
string
The string that is associated with the cancelable automation run.
brandstring
A unique identifier that represents the brand that should be used for rendering the notification.
templatestring
A unique identifier that can be mapped to an individual Notification. This could be the "Notification ID” on Notification detail pages (see the Notifications page in the Courier app) or a custom string mapped to the event in settings.
recipientstring
A unique identifier associated with the recipient of the delivered message.
datajson
An object that includes any data you want to pass to a message template. The data will populate the corresponding template variables.
profilejson
An object that includes any key-value pairs required by your chosen Integrations (see our Provider Documentation for the requirements for each Integration.) If profile information is included in the request and that information already exists in the profile for the recipientId, that information will be merged.
Responses
AUTH TOKEN
curl --request POST \
--url https://api.courier.com/automations/invoke \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"brand": "W50NC77P524K14M5300PGPEK4JMJ",
"template": "EXAMPLE_NOTIFICATION",
"recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
"data": {
"name": "Jane Doe",
"age": 27
},
"profile": {
"phone_number": "2025550125",
"email": "hello@example.com"
}
}
'
Response Example
{
"runId": "1-5e2b2615-05efbb3acab9172f88dd3f6f"
}

Example

Method: POST

URL: https://api.courier.com/automations/invoke

Body: ​

{
"automation": {
"steps": [
{
"action": "delay",
"duration": "2 minutes"
}
],
"cancelation_token": "abcdefgh12345678"
},
"brand": "W50NC77P524K14M5300PGPEK4JMJ",
"template": "S6CME56DCCM6DVQA7CVZR1MTPFPA",
"recipient": "8ec8c99a-c5f7-455b-9f60-8222b8a27056",
"data": {
"name": "Jane Doe",
"age": 27
},
"profile": {
"phone_number": "2025550125",
"email": "hello@example.com"
}
}