CommentDmRuleInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/breakreach-com/json-schema/breakreach-com-comment-dm-rule-input-schema.json",
  "title": "CommentDmRuleInput",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/breakreach-com-openapi.json#/components/schemas/CommentDmRuleInput",
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Instagram account or Facebook Page id from /v1/accounts (create only, a rule can't change account)"
    },
    "mediaId": {
      "type": [
        "string",
        "null"
      ],
      "description": "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"
    },
    "postId": {
      "type": "string",
      "description": "Instead of mediaId: a Breakreach post id published on this account"
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 60
      },
      "maxItems": 20,
      "description": "Words or phrases that trigger the DM, case and accents ignored. Empty = every comment"
    },
    "match": {
      "type": "string",
      "enum": [
        "contains",
        "exact"
      ],
      "default": "contains",
      "description": "contains = the keyword appears as a whole word or phrase; exact = the comment is just the keyword (punctuation and emoji around it ignored)"
    },
    "dmText": {
      "type": "string",
      "maxLength": 1000,
      "description": "The DM sent to the commenter, links allowed. {username} becomes their @handle on Instagram, their first name on Facebook. Required on create"
    },
    "publicReplies": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 300
      },
      "maxItems": 5,
      "description": "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"
    },
    "active": {
      "type": "boolean",
      "default": true
    },
    "workspace": {
      "type": "string"
    }
  }
}