TRtrycourier
Automations

Invoke an Ad Hoc Automation

Changed on

Runs a series of automation steps supplied inline, without a saved template, and returns a runId.

post/automations/invoke

Request

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
templatestring nullable

Response

runIdstring required

Changes

  • f76bed79a913Revision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional header request parameter x-idempotency-expiration

  • 7143ea51f307Revision changes
    • breaking

      the request property //// became not nullable

    • breaking

      the request property //// became required

    • breaking

      removed the enum value none of the request property ////

    • breaking

      removed from the // request property oneOf list

    • breaking

      the //// request property type changed from no type to object

    • breaking

      the ///// request property type changed from object to string

    • breaking

      the //// request property type changed from no type to object

    • warning

      removed from the request body allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed from the /// request property allOf list

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the request property /////

    • warning

      removed the request property ////

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property //// became nullable

    • info

      the request property //// became nullable

    • info

      the request property //// became nullable

    • info

      the request property //// became optional

    • info

      the request property //// became optional

    • info

      the request property //// became optional

    • info

      added the new DELETE enum value to the request property /////

    • info

      added the new PATCH enum value to the request property /////

    • info

      added the new PUT enum value to the request property /////