Resend API (unofficial showcase)
POST/automations

Create an automation

Creates an automation workflow from its name, steps, and connections. Supply at least one step, including a trigger step, and configure each step with its key, type, and configuration. A 201 response returns the new automation's identifier.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

Automation workflow definition. Provide name, steps, and connections; steps must include at least one trigger step.

namestringrequired
The name of the automation.
statusstringoptional
The initial status of the automation. Defaults to `disabled`.
Allowed:enableddisabledDefault:disabled
stepsarray<object>required
The steps that compose the automation workflow. Must include at least one `trigger` step.
connectionsarray<object>required
The connections between steps in the automation graph.

1 status code
201Returns an object containing the identifier of the created automation.
objectstringoptional
Type of the response object.
idstringoptional
The ID of the created automation.

Error handling

name, steps, and connections are required; name must contain at least one character. steps must contain 1 to 150 items and include a trigger step, with each step providing key, type, and config; each connection must provide from and to.