Skip to main content
POST
Create automation

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Headers

idempotency-key
string

Key that makes this request safe to retry. Reuse the same value when retrying a request that may already have succeeded — the original response is replayed with an Idempotency-Replay: true header. Use a new value for a new operation.

Required string length: 1 - 255
Example:

"9f8c2b1a-4d3e-4a6b-8c1d-2e3f4a5b6c7d"

Body

application/json
name
string
required
Example:

"Auto-reply to inquiries"

instructions
string
required

When the automation runs and what it does, in plain English. The trigger and any schedule are derived from this text.

Example:

"When a new message is received, reply to the sender thanking them for their inquiry and let them know we will respond within 24 hours."

description
string
Example:

"Sends an auto-reply to new inquiries"

agentId
string<uuid>

The agent the automation runs as. Omit it to use the organization's default agent. The agent must belong to your organization and be active.

Example:

"123e4567-e89b-12d3-a456-426614174000"

enabled
boolean
Example:

true

groupId
string<uuid>
Example:

"123e4567-e89b-12d3-a456-426614174000"

groupName
string
Example:

"Customer Support"

groupMetadata
object
maxExecutions
integer
Example:

100

expiresAt
string<date-time>
Example:

"2025-12-31T23:59:59Z"

Response

Automation created successfully

data
object
required
meta
object
Last modified on October 6, 2026