Publishing · Posts

Pin post

Pins a post.

POSThttps://api.pozy.ai/v1/posts/{postId}/pin

pinPost

Guides: Create a post, Edit, unpublish and delete

Request

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

Path parameters

Name	Type	Notes
`postId`required	string

Request body

application/json, required

platformstringrequired
accountIdstring

Example

curl -X POST "https://api.pozy.ai/v1/posts/6108a2cc742cb4e991051e0c/pin" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "platform": "instagram"
}'

const res = await fetch("https://api.pozy.ai/v1/posts/6108a2cc742cb4e991051e0c/pin", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    platform: "instagram"
  }),
});
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.post(
    "https://api.pozy.ai/v1/posts/6108a2cc742cb4e991051e0c/pin",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "platform": "instagram",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
pinnedboolean
platformPostIdstring
messagestring

200 response

{
  "success": true,
  "pinned": true,
  "platformPostId": "637f799b3039e6602e83fa4f",
  "message": "Hello from Pozy"
}

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.