Skip to main content
PATCH
Update an Automation

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Path Parameters

id
string
required

Automation ID

Body

application/json

Fields to change

name
string

1 to 100 characters

once_per_person
boolean
post_ids
string[]

Up to 100 platform post ids, each 1 to 100 characters, a comment must be on. An empty list means every post. Comment trigger only

status
enum<string>
Available options:
active,
paused
steps
object[]

Response

OK

account_id
string
Example:

"acc_01HZ9X3Q4R5M6N7P8V2K0W1J"

created_at
string
failed_count
integer

Actions that failed

fired_count
integer

Events the Automation ran against

id
string
Example:

"aut_01J9Z8Y7X6W5V4T3S2R1Q0P9N8"

name
string
Example:

"Send the link"

once_per_person
boolean

Reach each person at most once. A run in which every action failed does not count

post_ids
string[]

Up to 100 platform post ids, each 1 to 100 characters, a comment must be on. Omitted means every post. Comment trigger only

sent_count
integer

Actions carried out successfully

status
enum<string>
Available options:
active,
paused
Example:

"active"

steps
object[]

Up to 10 Steps forming a graph. One must have the key "start"

trigger
enum<string>

The kind of inbound event that fires the Automation

Available options:
comment,
dm
Example:

"comment"

updated_at
string