Create a Comment to DM rule

Starts watching the comments of the account (Breakreach subscribes it to Instagram's comment webhooks, or the Page's feed webhooks). Requires a Pro, Agency or Developer plan on the workspace.

post/v1/comment-dm-rules

Request

  • Base URL: https://api.breakreach.com
  • URL: https://api.breakreach.com/v1/comment-dm-rules
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A unique string for this request, e.g. a UUID. A retry with the same key and body within 24 hours returns the first response (with the header Idempotent-Replayed: true) instead of running again. Printable ASCII, no spaces.

Request body

accountIdstring

Instagram account or Facebook Page id from /v1/accounts (create only, a rule can't change account)

mediaIdstring nullable

Instagram or Facebook post id to watch (from /v1/comment-dm-rules/media or the postId of /v1/comments). Omit or null for every post

postIdstring

Instead of mediaId: a Breakreach post id published on this account

keywordsstring[]

Words or phrases that trigger the DM, case and accents ignored. Empty = every comment

match'contains' | 'exact'

contains = the keyword appears as a whole word or phrase; exact = the comment is just the keyword (punctuation and emoji around it ignored)

dmTextstring

The DM sent to the commenter, links allowed. {username} becomes their @handle on Instagram, their first name on Facebook. Required on create

publicRepliesstring[]

Optional public replies under the comment once the DM is sent, one picked at random. {username} becomes their @handle on Instagram, their first name on Facebook

activeboolean
workspacestring

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.