REST APIAPI reference
Posts
Posts, their targets, scheduling and publishing
33 operations, generated from apps/api/openapi.yaml (OpenAPI 3.2). Each page has the parameters, request body, responses and code samples, and a Send button to try the request against your cloud instance.
- GET
/v1/collections/{id}/postsList posts of one collectionList posts of one collection (posts:read) - GET
/v1/postsList posts across collectionsList posts across collections (posts:read) - POST
/v1/postsCreate a postCreate a post (posts:write; scheduling or publishing it right away also needs posts:publish) - POST
/v1/posts/deleteDelete several postsDelete several posts (posts:delete) - GET
/v1/posts/{id}Get a post with its targetsGet a post with its targets (posts:read) - DELETE
/v1/posts/{id}Delete a postDelete a post; its events stay as history (posts:delete) - PATCH
/v1/posts/{id}Edit a draft, scheduled or failed postEdit a draft, scheduled or failed post (posts:write) - POST
/v1/posts/{id}/scheduleSet the publish time and make the post scheduledSet the publish time and make the post scheduled (posts:publish) - POST
/v1/posts/{id}/publishPublish nowPublish now (posts:publish) - POST
/v1/posts/{id}/cancelTake a scheduled post off the scheduleTake a scheduled post off the schedule; it becomes a draft (posts:publish) - GET
/v1/posts/{id}/metricsThe post's numbers per channel, read from each platform that reports themThe post's numbers per channel, read from each platform that reports them (posts:read) - PUT
/v1/posts/{id}/targets/{channel}/metricsYour own automation sends the numbers of a post it publishedYour own automation sends the numbers of a post it published (posts:publish) - GET
/v1/posts/{id}/previewsThe post's preview links, newest firstThe post's preview links, newest first; tokens are never shown again (posts:read) - POST
/v1/posts/{id}/previewsA link to a read-only preview page of the post where anyone with it can commentA link to a read-only preview page of the post where anyone with it can comment (posts:write) - DELETE
/v1/posts/{id}/previews/{preview}Stop a preview link from workingStop a preview link from working (posts:write) - GET
/v1/posts/{id}/commentsThe post's feedback threads: reviewers' comments from its preview pagesThe post's feedback threads: reviewers' comments from its preview pages (with their email) and the team's replies, oldest first (posts:read) - POST
/v1/posts/{id}/commentsComment on the post's feedback as the teamComment on the post's feedback as the team (a reply with parent_id, or a new thread) (posts:write) - POST
/v1/posts/{id}/comments/{comment}/resolveResolve a feedback threadResolve a feedback thread (posts:write) - POST
/v1/posts/{id}/comments/{comment}/reopenReopen a resolved feedback threadReopen a resolved feedback thread (posts:write) - DELETE
/v1/posts/{id}/comments/{comment}Remove a commentRemove a comment (posts:write); removing a thread's first comment removes its replies - GET
/v1/previews/{token}The preview page's content, as each channel will show the postThe preview page's content, as each channel will show the post (no credentials; the token is the key) - POST
/v1/previews/{token}/commentsLeave a comment on a previewed postLeave a comment on a previewed post (no credentials; 20 per 10 minutes per address, 30 an hour per link) - POST
/v1/previews/{token}/comments/{comment}/resolveResolve a feedback thread from the preview pageResolve a feedback thread from the preview page (no credentials; counted with the comments per address) - POST
/v1/previews/{token}/comments/{comment}/reopenReopen a resolved feedback thread from the preview pageReopen a resolved feedback thread from the preview page (no credentials) - GET
/v1/previews/{token}/media/{media}A picture or video of the previewed postA picture or video of the previewed post (its own or its comments' media only) - GET
/v1/posts/{id}/eventsThe post's history, newest firstThe post's history, newest first (events:read) - GET
/v1/posts/{id}/previewThe text each target will carry and what its provider objects toThe text each target will carry and what its provider objects to (posts:read) - POST
/v1/posts/{id}/targets/{channel}/resultClose a target on your own automation that waits for a resultClose a target on your own automation that waits for a result (posts:publish) - POST
/v1/posts/{id}/targets/{channel}/retryTry a failed target once more, nowTry a failed target once more, now (posts:publish) - POST
/v1/posts/{id}/purgeDelete a post and its history, including every event about itDelete a post and its history, including every event about it (admin) - GET
/v1/workWhat the workspace asks your automation forWhat the workspace asks your automation for (posts:read)