Skip to main content
PATCH
Update an automation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
name
string
Example:

"Guide lead magnet"

mediaIds
string[]

Platform media ids to watch (mediaId from get_account_media). Empty = every post on the account, including future ones.

keywords
string[]

Trigger words. Matching is case- and accent-insensitive. Required unless matchType is any.

Example:
matchType
enum<string>
default:contains
Available options:
contains,
exact,
any
dmText
string

The DM sent to the commenter.

dmButtonLabel
string

Button label (20 chars max shown). Empty removes the button, along with dmButtonUrl.

dmButtonUrl
string

Button destination (https URL). Empty removes the button, along with dmButtonLabel.

publicReplyText
string

Optional public reply posted under the comment.

oncePerUser
boolean
default:true

Send at most one DM per person for this automation.

status
enum<string>
Available options:
active,
paused

Response

200 - undefined