Skip to main content
POST
Create a comment-to-DM automation

Authorizations

Authorization
string
header
required

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

Body

application/json
accountId
string
required

Instagram or Facebook Page account to watch.

name
string
required
Example:

"Guide lead magnet"

dmText
string
required

The DM sent to the commenter.

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
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.

Response

201 - undefined