GuidesChangelogAPI Reference
API Reference

/api/v5/post/{post_id}

put
https://percolate.com/api/v5/post/

Update and return a post.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string | null

Creates an approval workflow for this post. If the post is already part of an approval workflow, this will overwrite it. (see approvals for details).

string | null

The id of user who is assigned to the post.

string | null

The channel to which this post has been or will be published.

string | null

A short description about the post.

ext
object | null

The structure defined by schema_id.

date-time | null

When this post should/did go live. If null and status is live, live_at will be the current time. In all other cases null indicates that the post should go live ASAP. Note - regardless of whether a post is published or not, live_at reflects when the post goes live to the public.

string | null

The timezone the post was intended to be scheduled in (usually the device's timezone unless an app specifies otherwise). live_at offset isn't enough to know.

string | null

The name of the post.

origin_ids
array

Tracks where the post was created from.

origin_ids
string | null

The unique platform ID.

string | null

ID of the production workflow that the post is attached to. Note: Post's production_workflow_id and approval_workflow_id values are independent of one another.

string | null

The schema defining the type of post (must be a schema of type post matching the channel)

string

A valid license ID ^license:\d+$.

string
enum

Below you'll find all possible statuses during a post's life cycle.

draft

The post is in a holding pattern.

approvals

The post is currently part of an approval workflow. A post can be removed from approvals by reverting it back to draft. Users with post:publish permission may bypass approvals by setting the status to queued. Once approved, the post status will either be queued or set back to draft if the current status is approvals.queued or approvals.draft.

queued

The post is queued to be published to the associated channel. Publishing happens only once live_at is in the past or null. A post is either queued automatically upon approval or manually if a user has the post:publish permission. Only a queued or queued.paused status can be changed by the user (usually back to draft).

  • queued.paused: the post is queued but publishing is currently paused (the post cannot be published) - queued.publishing: The post is currently being published - queued.unpublishing: The post is currently being unpublished - queued.published: the post is still queued and has been successfully published. This indicates that the post hasn't gone live yet usually because of an external queue or some privacy controls. - queued.error: there was an error sending the post to the channel

live

The post is now live to the public on the associated channel. This state is either set automatically after queued.published or manually by a user with post:publish permission. In order to change the post's status to live, live_at is required.

Unpublished

The post is now unpublished on the external platform. If post failed to unpublish, it will get reverted back to live from queued.unpublishing.

term_ids
array of strings

An array of term IDs

term_ids
string | null

The URL this post was published to. Can only be set if status is "live" or "queued.published." For some platforms, directly setting url may not be supported; only custom platforms are guaranteed to allow this. NOTE this is always empty in bulk reads, for performance reasons.

string
length ≤ 100

Opaque external ID of a live post on the external service. Can only be set if status is "live" or "queued.published."

metadata
array of objects

This attribute can be used when post and metadata must be created under the same transaction.
e.g. Publishing a post with metadata immediately with automatic link tracking. (Preview)

metadata
Responses

Retry-After header

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago