Skip to main content
PATCH
Update Automation

Autorizaciones

Authorization
string
header
requerido

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.

Scopes

automation:write

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Automation ID, prefixed ato_.

Cuerpo

application/json
name
string

The automation's name, shown on the dashboard. Up to 255 characters.

Ejemplo:

"Still running"

secrets
object

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.

Ejemplo:
status
enum<string>

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.

Opciones disponibles:
active,
closed,
stopped
Ejemplo:

"stopped"

trigger_event
enum<string> | null

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.

Opciones disponibles:
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
Ejemplo:

"payment.succeeded"

Respuesta

Automation updated

account_id
string
requerido

ID of the account the automation belongs to, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

active_enrollments_count
integer
requerido

Members currently in the automation.

Ejemplo:

0

created_at
string
requerido

When the automation was created, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"

created_by_actor
object
requerido

Who created the automation.

draft_version
integer
requerido

The version that step edits change. Always published_version plus one, or 1 before the first publish.

Ejemplo:

2

has_unpublished_changes
boolean
requerido

Whether the draft has edits that POST /automations/{id}/publish would publish. Always true before the first publish.

Ejemplo:

false

id
string
requerido

Automation ID, prefixed ato_.

Ejemplo:

"ato_xxxxxxxxxxxxxx"

name
string
requerido

The automation's name, shown on the dashboard. Up to 255 characters.

Ejemplo:

"After an order"

published_at
string | null
requerido

When the automation was last published, as an ISO 8601 timestamp. null until its first publish.

Ejemplo:

"2026-01-01T12:00:00.000Z"

published_by_actor
object | null
requerido

Who last published the automation. null until its first publish.

published_version
integer | null
requerido

The version new members start on. null until the automation is first published.

Ejemplo:

1

secret_names
string[]
requerido

Names of the automation's secrets, which its steps' code reads as environment variables. Their values are never returned.

status
enum<string>
requerido

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.

Opciones disponibles:
active,
closed,
stopped
Ejemplo:

"active"

total_enrollments_count
integer
requerido

How many times members have enrolled in the automation, including enrollments that have ended.

Ejemplo:

0

trigger_event
enum<string> | null
requerido

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.

Opciones disponibles:
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
Ejemplo:

"payment.succeeded"

updated_at
string
requerido

When the automation was last updated, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"