Analytics · Watchlist

Update a daily watchlist rule

Updates a daily watchlist rule. Fields you leave out keep their current values. Works with Instagram and YouTube accounts.

PATCHhttps://api.pozy.ai/v1/watchlist/rules/{ruleId}

Instagram and YouTubeupdateWatchlistRule

Request

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

Path parameters

Name	Type	Notes
`ruleId`required	string

Request body

application/json, required

namestring
Up to 80 characters.
liststring
List id or name the rule reads from.
Can be null.
filterobject
8 child fields
- listIdstring
  Can be null.
- platformstring
  One of instagram, youtube. Can be null.
- formatsarray of string
  Each item: one of reel, carousel, image, video, short.
- minViewsinteger
  Can be null.
- minLikesinteger
  Can be null.
- minCommentsinteger
  Can be null.
- outlierMinnumber
  At least 1. Can be null.
- maxAgeDaysinteger
  1 to 30. Can be null.
targetAccountIdsarray of string
At least 1 item. Up to 10 items.
hourUtcinteger
Default 8. 0 to 23.
maxPerRuninteger
Default 3. 1 to 10.
enabledboolean
Default true.

Example

curl -X PATCH "https://api.pozy.ai/v1/watchlist/rules/6cd4059483de62b474d02fe7" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "list": "string",
  "filter": {
    "listId": "64272240067877d9e057f3da",
    "platform": "instagram",
    "formats": [
      "reel"
    ]
  },
  "targetAccountIds": [
    "string"
  ]
}'

const res = await fetch("https://api.pozy.ai/v1/watchlist/rules/6cd4059483de62b474d02fe7", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Acme",
    list: "string",
    filter: {
      listId: "64272240067877d9e057f3da",
      platform: "instagram",
      formats: [
        "reel"
      ]
    },
    targetAccountIds: [
      "string"
    ]
  }),
});
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.patch(
    "https://api.pozy.ai/v1/watchlist/rules/6cd4059483de62b474d02fe7",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "name": "Acme",
        "list": "string",
        "filter": {
            "listId": "64272240067877d9e057f3da",
            "platform": "instagram",
            "formats": [
                "reel",
            ],
        },
        "targetAccountIds": [
            "string",
        ],
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

ruleobjectrequired
11 child fields
- idstringrequired
- namestringrequired
- filterobjectrequired
  8 child fields
  listIdstring
  Can be null.
  platformstring
  One of instagram, youtube. Can be null.
  formatsarray of string
  Each item: one of reel, carousel, image, video, short.
  minViewsinteger
  Can be null.
  minLikesinteger
  Can be null.
  minCommentsinteger
  Can be null.
  outlierMinnumber
  At least 1. Can be null.
  maxAgeDaysinteger
  1 to 30. Can be null.
- targetAccountIdsarray of stringrequired
- actionstring
  One of draft.
- hourUtcintegerrequired
  0 to 23.
- maxPerRunintegerrequired
  1 to 10.
- enabledbooleanrequired
- lastRunAtstring (date-time)
  Can be null.
- lastResultobject
  Can be null.
- createdAtstring (date-time)

200 response

{
  "rule": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "filter": {
      "listId": "64272240067877d9e057f3da",
      "platform": "instagram",
      "formats": [
        "reel"
      ],
      "minViews": 1,
      "minLikes": 1,
      "minComments": 1,
      "outlierMin": 12.5,
      "maxAgeDays": 1
    },
    "targetAccountIds": [
      "string"
    ],
    "action": "draft",
    "hourUtc": 1,
    "maxPerRun": 1,
    "enabled": true,
    "lastRunAt": "2026-10-02T09:00:00.000Z",
    "lastResult": {},
    "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 read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.