v53

OpenAPI 3.0.1raw.githubusercontent.com2026-07-31147343479.6 KB
Automations

Invoke an Automation

Starts an automation run from a saved template for one recipient, with optional data and profile, and returns a runId.

post/automations/{templateId}/invoke

Path parameters

templateIdstring required

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

Headers

Idempotency-Keystring

A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

brandstring nullable
dataobject nullable
profileobject nullable
recipientstring nullable required
templatestring nullable

Response

runIdstring required