Update Automation
Renames an automation, changes its trigger event before its first publish, sets its secrets, or changes its status. Changing secrets or status also needs automation:manage. Use POST /automations/{id}/publish to publish the draft, and the steps endpoints to change what it does.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-11-05-1"
Path Parameters
Automation ID, prefixed ato_.
Body
The automation's name, shown on the dashboard. Up to 255 characters.
"After a first order"
Secrets to set, by name, merged into the automation's: a name set to null is removed. Step code reads them as environment variables, and no endpoint returns their values. Names are uppercase letters, digits and underscores, starting with a letter, up to 64 characters. Up to 50 secrets, each up to 4 KB.
active enrolls members and runs their steps. closed stops new enrollments and lets members already in it finish. stopped stops new enrollments and ends every member's enrollment. active and closed need a published version.
active, closed, stopped "active"
The webhook event that enrolls the member it's about, such as payment.succeeded. null for an automation that only POST /automations/{id}/trigger enrolls into. Fixed once the automation has been published.
payment.succeeded, payment.failed, membership.activated, membership.trial_ending_soon, member.created, invoice.created, invoice.paid, invoice.past_due, refund.created, dispute.created, resolution_center_case.created, resolution_center_case.decided, course_lesson_interaction.completed, null "payment.succeeded"
Response
Automation updated
ID of the account the automation belongs to, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
Members currently in the automation.
0
When the automation was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Who created the automation.
The version that step edits change. Always published_version plus one, or 1 before the first publish.
2
Whether the draft has edits that POST /automations/{id}/publish would publish. Always true before the first publish.
false
Automation ID, prefixed ato_.
"ato_xxxxxxxxxxxxxx"
The automation's name, shown on the dashboard. Up to 255 characters.
"After an order"
When the automation was last published, as an ISO 8601 timestamp. null until its first publish.
"2026-01-01T12:00:00.000Z"
Who last published the automation. null until its first publish.
The version new members start on. null until the automation is first published.
1
Names of the automation's secrets, which its steps' code reads as environment variables. Their values are never returned.
active enrolls members and runs their steps. closed enrolls no one new, and members already in it finish. stopped enrolls no one, and its members' enrollments have ended. A new automation is stopped until its first publish makes it active.
active, closed, stopped "active"
How many times members have enrolled in the automation, including enrollments that have ended.
0
The webhook event that enrolls the member it's about, such as payment.succeeded. null for an automation that only POST /automations/{id}/trigger enrolls into. Fixed once the automation has been published.
payment.succeeded, payment.failed, membership.activated, membership.trial_ending_soon, member.created, invoice.created, invoice.paid, invoice.past_due, refund.created, dispute.created, resolution_center_case.created, resolution_center_case.decided, course_lesson_interaction.completed, null "payment.succeeded"
When the automation was last updated, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"

