Automations · Comment Automations

List comment-to-DM automations

Returns comment-to-DM automations.

GEThttps://api.pozy.ai/v1/comment-automations

listCommentAutomations

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`profileId`	string

Example

curl -X GET "https://api.pozy.ai/v1/comment-automations" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/comment-automations", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/comment-automations",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
automationsarray of object
34 child fields
- idstring
- namestring
- platformstring
  One of instagram, facebook, tiktok, threads, linkedin, youtube.
- triggerstring
  One of comment, live_comment, story_reply, story_mention.
- accountIdstring
- platformPostIdstring
- postTitlestring
- postIdstring
- keywordsarray of string
- matchModestring
  One of exact, contains, word.
- excludeKeywordsarray of string
- typoToleranceboolean
- dmMessagestring
- buttonsarray of object
  5 child fields
  typestringrequired
  One of url, postback, phone.
  titlestringrequired
  Up to 20 characters.
  urlstring (URL)
  payloadstring
  phonestring
- templateobject
  3 child fields
  typestringrequired
  One of generic.
  imageAspectRatiostring
  One of horizontal, square.
  elementsarray of objectrequired
  At least 1 item. Up to 10 items.
  4 child fields
  titlestringrequired
  Up to 80 characters.
  subtitlestring
  Up to 80 characters.
  imageUrlstring (URL)
  buttonsarray of object
  Up to 3 items.
  4 child fields
  typestringrequired
  One of url, postback.
  titlestringrequired
  Up to 20 characters.
  urlstring (URL)
  payloadstring
- commentReplystring
- dmMessageVariationsarray of string
- commentReplyVariationsarray of string
- linkTrackingboolean
- clickTagstring
- dmDelaySecondsinteger
- commentReplyDelaySecondsinteger
- alsoMatchInDmsboolean
- repeatPolicyobject
  2 child fields
  modestringrequired
  One of once, every_comment. Default once.
  cooldownHoursinteger
  1 to 8760.
- dedupeSameTextHoursinteger
- publicReplyPolicystring
  One of after_dm, always.
- actionsobject
  2 child fields
  likeCommentboolean
  hideCommentboolean
- quickRepliesarray of object
  3 child fields
  titlestringrequired
  Up to 20 characters.
  payloadstringrequired
  imageUrlstring (URL)
- dmMediaobject
  2 child fields
  typestringrequired
  One of image, video, audio, file.
  urlstring (URL)required
- audienceobject
  4 child fields
  followerStatusstring
  One of any, follower, non_follower. Default any.
  minFollowerCountinteger
  At least 0.
  whenUnknownstring
  One of send, skip, verify. Default send.
  tapToUnlockboolean
  Default false.
- followGateobject
  4 child fields
  messagestring
  Up to 640 characters.
  buttonLabelstring
  Up to 20 characters.
  profileButtonLabelstring
  1 to 20 characters.
  notFollowingMessagestring
  Up to 1000 characters.
- isActiveboolean
- statsobject
  13 child fields
  triggeredinteger
  dmsSentinteger
  dmsFailedinteger
  uniqueContactsinteger
  trackedSendsinteger
  linkClicksinteger
  uniqueClicksinteger
  deliveredinteger
  readinteger
  audienceSkippedinteger
  followGateSentinteger
  followGatePassedinteger
  followGateFailedinteger
- createdAtstring (date-time)

200 response

{
  "success": true,
  "automations": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme",
      "platform": "instagram",
      "trigger": "comment",
      "accountId": "696e0b682d0a31188e7a2ba9",
      "platformPostId": "637f799b3039e6602e83fa4f",
      "postTitle": "string",
      "postId": "6108a2cc742cb4e991051e0c",
      "keywords": [
        "string"
      ],
      "matchMode": "exact",
      "excludeKeywords": [
        "string"
      ],
      "typoTolerance": true,
      "dmMessage": "Hello from Pozy",
      "buttons": [
        {
          "type": "url",
          "title": "Launch day",
          "url": "https://pozy.ai/media/example-1.jpg",
          "payload": "string",
          "phone": "+14155550123"
        }
      ],
      "template": {
        "type": "generic",
        "imageAspectRatio": "horizontal",
        "elements": [
          {
            "title": "Launch day",
            "subtitle": "string",
            "imageUrl": "https://pozy.ai/media/example-1.jpg",
            "buttons": [
              {
                "type": "url",
                "title": "Launch day",
                "url": "https://pozy.ai/media/example-1.jpg",
                "payload": "string"
              }
            ]
          }
        ]
      },
      "commentReply": "string",
      "dmMessageVariations": [
        "Hello from Pozy"
      ],
      "commentReplyVariations": [
        "string"
      ],
      "linkTracking": true,
      "clickTag": "string",
      "dmDelaySeconds": 1,
      "commentReplyDelaySeconds": 1,
      "alsoMatchInDms": true,
      "repeatPolicy": {
        "mode": "once",
        "cooldownHours": 1
      },
      "dedupeSameTextHours": 1,
      "publicReplyPolicy": "after_dm",
      "actions": {
        "likeComment": true,
        "hideComment": true
      },
      "quickReplies": [
        {
          "title": "Launch day",
          "payload": "string",
          "imageUrl": "https://pozy.ai/media/example-1.jpg"
        }
      ],
      "dmMedia": {
        "type": "image",
        "url": "https://pozy.ai/media/example-1.jpg"
      },
      "audience": {
        "followerStatus": "any",
        "minFollowerCount": 42,
        "whenUnknown": "send",
        "tapToUnlock": false
      },
      "followGate": {
        "message": "Hello from Pozy",
        "buttonLabel": "string",
        "profileButtonLabel": "string",
        "notFollowingMessage": "Hello from Pozy"
      },
      "isActive": true,
      "stats": {
        "triggered": 1,
        "dmsSent": 1,
        "dmsFailed": 1,
        "uniqueContacts": 1,
        "trackedSends": 1,
        "linkClicks": 1,
        "uniqueClicks": 1,
        "delivered": 1,
        "read": 1,
        "audienceSkipped": 1,
        "followGateSent": 1,
        "followGatePassed": 1,
        "followGateFailed": 1
      },
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Comment Automations

POSTCreate comment-to-DM automation GETGet automation details PATCHUpdate automation settings DELDelete automation GETList automation logs