Analytics · Watchlist

Save a post to the swipe file

Saves a post to the swipe file. Works with Instagram and YouTube accounts.

PUThttps://api.pozy.ai/v1/watchlist/posts/{postId}/save

Instagram and YouTubesaveWatchlistPost

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
`postId`required	string

Example

curl -X PUT "https://api.pozy.ai/v1/watchlist/posts/6108a2cc742cb4e991051e0c/save" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/watchlist/posts/6108a2cc742cb4e991051e0c/save", {
  method: "PUT",
  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.put(
    "https://api.pozy.ai/v1/watchlist/posts/6108a2cc742cb4e991051e0c/save",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

postobjectrequired
22 child fields
- idstringrequired
- platformstringrequired
  One of instagram, youtube.
- externalIdstring
- accountobject
  5 child fields
  idstring
  handlestring
  displayNamestring
  Can be null.
  followersinteger
  Can be null.
  listobject
  Can be null.
  2 child fields
  idstring
  namestring
- permalinkstring
  Can be null.
- formatstringrequired
  One of reel, carousel, image, video, short.
- hookstring
  Can be null.
- captionstring
  Can be null.
- thumbnailUrlstring
  Can be null.
- mediaUrlstring
  Can be null.
- durationSecinteger
  Can be null.
- postedAtstring (date-time)required
- viewsinteger
  Can be null.
- likesinteger
  Can be null.
- commentsinteger
  Can be null.
- engagementinteger
- engagementRatenumber
  Can be null.
- outlierScorenumber
  Can be null.
- outlierBasisstring
  One of views, engagement. Can be null.
- statsUpdatedAtstring (date-time)
- savedboolean
- replicatedobject
  Can be null.
  3 child fields
  pozyPostIdstring
  Can be null.
  ruleIdstring
  Can be null.
  atstring (date-time)

200 response

{
  "post": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "externalId": "62c9d6bdf3fa891362623a67",
    "account": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "handle": "acme",
      "displayName": "Acme",
      "followers": 1,
      "list": {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "name": "Acme"
      }
    },
    "permalink": "string",
    "format": "reel",
    "hook": "string",
    "caption": "Hello from Pozy",
    "thumbnailUrl": "https://pozy.ai/media/example-1.jpg",
    "mediaUrl": "https://pozy.ai/media/example-1.jpg",
    "durationSec": 1,
    "postedAt": "2026-10-02T09:00:00.000Z",
    "views": 1,
    "likes": 1,
    "comments": 1,
    "engagement": 1,
    "engagementRate": 12.5,
    "outlierScore": 12.5,
    "outlierBasis": "views",
    "statsUpdatedAt": "2026-10-02T09:00:00.000Z",
    "saved": true,
    "replicated": {
      "pozyPostId": "65c07fe18b8de4a270f358ad",
      "ruleId": "6cd4059483de62b474d02fe7",
      "at": "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.

Request

Path parameters

Example

Response

Errors

More in Watchlist