Developer documentation

REST API

Operations and scopes

The base path is /api/v1. Methods, paths, and scopes come from OpenAPI; English summaries describe those same operations. Live accounts and generated SDKs remain unverified.

Validate before publishing

curl -X POST 'https://<service-domain>/api/v1/posts/validate' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{"content":"A product update is coming.","accountIds":["<ACCOUNT_ID>"]}'
MethodPathOperationScope
GET/api/v1/accountsList connected platform accountsaccounts:read
DELETE/api/v1/accounts/{id}Disconnect an account and retain publication historyaccounts:write
GET/api/v1/platformsGet platform rules and availabilityaccounts:read
POST/api/v1/posts/validateValidate without saving or publishingposts:read
POST/api/v1/postsPublish, schedule, or save a draft; Idempotency-Key is recommendedposts:write
GET/api/v1/postsList post historyposts:read
GET/api/v1/posts/{id}Get post and per-target resultsposts:read
PATCH/api/v1/posts/{id}Edit a draft or scheduled postposts:write
DELETE/api/v1/posts/{id}Delete a draft or schedule, or request deletion on published platformsposts:write
POST/api/v1/posts/{id}/metrics/refreshRefresh available engagement metrics for a published postposts:read
POST/api/v1/posts/{id}/publishPublish a draft or scheduled post nowposts:write
POST/api/v1/posts/{id}/retryRetry only failed targetsposts:write
POST/api/v1/media/presignCreate an upload URL with fileName, contentType, and bytesposts:write
POST/api/v1/media/{id}/completeComplete and verify an uploadposts:write
POST/api/v1/media/from-urlImport media from a public URLposts:write
DELETE/api/v1/media/{id}Delete unused mediaposts:write
GET/api/v1/quotaGet monthly quota and per-platform daily limitsposts:read
GET/api/v1/queue-slotsList recurring queue slot rulesposts:read
POST/api/v1/queue-slotsCreate a recurring queue slot ruleposts:write
PATCH/api/v1/queue-slots/{id}Edit or pause a queue slot ruleposts:write
DELETE/api/v1/queue-slots/{id}Revoke a queue slot ruleposts:write
GET/api/v1/webhooksList customer webhook subscriptionswebhooks:read
POST/api/v1/webhooksCreate a customer webhook subscriptionwebhooks:write
PATCH/api/v1/webhooks/{id}Edit a webhook or rotate its secretwebhooks:write
DELETE/api/v1/webhooks/{id}Revoke a webhook subscriptionwebhooks:write
GET/api/v1/webhooks/{id}/deliveriesList webhook deliveries and attemptswebhooks:read
POST/api/v1/webhooks/{id}/deliveries/{deliveryId}/retryRetry a confirmed failed deliverywebhooks:write
GET/api/v1/automations/instagram-dm-backfills/previewPreview a page of past comments on owned media; external sending is blockedautomations:read
GET/api/v1/automations/instagram-dm-backfillsList recent past-comment preparation jobsautomations:read
POST/api/v1/automations/instagram-dm-backfillsExplicitly request past-comment preparation; external sending is blockedautomations:write
GET/api/v1/automations/instagram-dm-backfills/{id}Get preparation counts and ordered resultsautomations:read
PATCH/api/v1/automations/instagram-dm-backfills/{id}Prepare the next page, pause, or resume preparationautomations:write
GET/api/v1/automations/instagram-dm-rulesList Instagram comment automation rulesautomations:read
POST/api/v1/automations/instagram-dm-rulesCreate a draft Instagram comment automation ruleautomations:write
GET/api/v1/automations/instagram-dm-runsList Instagram comment automation runsautomations:read
PATCH/api/v1/automations/instagram-dm-rules/{id}Edit, pause, activate, or revoke an Instagram comment automation ruleautomations:write
GET/api/v1/accounts/{id}/media/{mediaId}/commentsList top-level comments on owned Instagram mediacomments:read
POST/api/v1/accounts/{id}/media/{mediaId}/comments/{commentId}/actionsRequest a manual reply, hide, or unhide actioncomments:write
GET/api/v1/comment-actions/{id}Get a manual Instagram comment action resultcomments:read