Posts

/posts/{post_id}/retract

Removes the published copy from the channel and marks the post deleted. The ProductByte record stays, so the post keeps its history and analytics — use DELETE to forget the record instead.

Only a published post can be retracted, and only on channels that support deletion. Instagram and TikTok do not: they answer API_CHANNEL_RETRACT_UNSUPPORTED and the post must be removed in the provider's own app.

The channel is called synchronously. A 200 means the provider confirmed the removal; if it refuses, the post stays published and nothing is changed here.

Requires the posts:write scope.

post/projects/{project_id}/posts/{post_id}/retract

Request

  • Base URL: https://api.productbyte.com/v1
  • URL: https://api.productbyte.com/v1/projects/{project_id}/posts/{post_id}/retract
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project the post belongs to.

post_idstring required

The published post to retract.

Response

The retracted post, now deleted.

idstring required

Identifier for this post.

channel_idstring required

The channel it publishes to.

campaign_idstring

The campaign it belongs to. Absent when the post is unassigned — posts still need a home internally, but that grouping is bookkeeping and is never reported as a campaign.

status'draft' | 'scheduled' | 'publishing' | 'published' | 'failed' | 'deleted' required

Where the post actually got to. Poll this to learn the outcome.

copystring required

The text published alongside the media.

scheduled_atstring date-time

When it publishes, if it is scheduled.

published_atstring date-time

When it published, once it has.

permalinkstring

Link to the published post, when the provider gives one.

updated_atstring date-time required

When the post last changed. Pass the newest one back as updated_since to poll for what changed.

Changes

No recorded changes to this operation across all 2 revisions of this API.