Skip to main content
POST
/
automations
/
{templateId}
/
invoke
Invoke an Automation
curl --request POST \
  --url https://api.courier.com/automations/{templateId}/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "brand": "<string>",
  "data": {},
  "profile": {},
  "recipient": "<string>",
  "template": "<string>"
}'
{
  "runId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
templateId
string
required

A unique identifier representing the automation template to be invoked. This could be the Automation Template ID or the Automation Template Alias.

Body

application/json
​
recipient
string | null
required
​
brand
string | null
​
data
object | null
​
profile
object | null
​
template
string | null

Response

200 - application/json
​
runId
string
required