v2

latestOpenAPI 3.1.02026-08-075421692.0 MB

Comment Automations

Update automation settings

Update an automation's keywords, DM message, inline buttons, comment reply, or active status. Pass buttons: [] to clear all buttons. When buttons is non-empty, dmMessage (the new one if you're changing it, otherwise the stored one) must be 640 characters or less.

patch/v1/comment-automations/{automationId}

Path parameters

automationIdstring required

Request body

namestring

trigger'comment' | 'story_reply'

What fires the automation. Changing it detaches the automation from its bound post or story (a post id and a story id are different objects), unless this same request sets a new binding. 'story_reply' is Instagram only.

keywordsstring[]

matchMode'exact' | 'contains' | 'word'

How a keyword is compared with the comment. 'contains' (default) matches anywhere, even inside another word (keyword 'app' fires on 'happy'). 'word' matches the keyword only as a standalone word. 'exact' requires the whole comment to be exactly the keyword.

excludeKeywordsstring[]

Comments containing one of these never trigger the automation, even when a trigger keyword also matches. Compared using the same matchMode.

typoToleranceboolean

Only with matchMode=word: also fire on close misspellings of a keyword (one edit for 4-7 character keywords, two from 8 up). Keywords shorter than 4 characters are never fuzzy-matched.

dmMessagestring

commentReplystring

dmMessageVariationsstring[]

Alternate DM texts for random rotation (see create). Pass [] to clear.

commentReplyVariationsstring[]

Alternate public replies for random rotation. Pass [] to clear.

linkTrackingboolean

Wrap link buttons in a tracked redirect to count clicks. Pass false to send links untouched.

clickTagstring

Tag applied to a contact when they click a tracked link (requires linkTracking). Empty string clears it.

dmDelaySecondsinteger

Seconds to wait after the trigger before sending the DM. Send 0 to clear the delay and reply immediately.

commentReplyDelaySecondsinteger

Seconds to wait before posting the public comment reply. Send 0 to clear it. The reply never goes out before the DM.

isActiveboolean

Response

Automation updated

successboolean