Skip to main content
PUT
Update automation

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Path Parameters

id
string<uuid>
required

Automation UUID

Example:

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

Body

application/json
name
string
Example:

"Auto-reply to inquiries"

description
string
Example:

"Sends an auto-reply to new inquiries"

instructions
string

Changing the instructions regenerates the automation: it stops running, its trigger and schedule are re-derived, and it waits for approval again.

Example:

"Reply to the sender thanking them for their inquiry and let them know we will respond within 24 hours."

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"

status
enum<string>

Pause or resume the automation (paused / active). Only an automation that is already active or paused accepts either value; anything else is rejected with 409 — approve it in the app first.

Available options:
draft,
evaluation_failed,
code_generation_failed,
pending_approval,
active,
paused,
completed,
expired,
failed,
archived
Example:

"paused"

Response

Automation updated successfully

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