Skip to content

content_publications_cancel

Cancel a publication that has not finished.

Tool

content_publications_cancel

Cancel a publication that has not finished.

Cancel a publication that has not finished. A publication whose reminder already went out can still be cancelled — until someone confirms it. An auto publication that is being sent to the network right now is refused with 409 publication_in_flight: wait for its outcome. A finished publication that may still be live (its output is uncertain) blocks the output until a person settles it: confirm it if the post is on the network, or cancel it with checkedNotLive: true after checking that it is not.

Behavior

HTTP
POST /content/publications/:id/cancel

Arguments

Name
Type
Required
Description
id
string
•
The publication id returned by content_publications_schedule.
checkedNotLive
boolean
—
Only for a FINISHED publication that may still be live (an output in state uncertain: an automatic attempt ended without an answer). Pass true to state that you looked at the network and the post is NOT there; the publication then stops blocking its output. Without it such a cancel is refused with 409 may_already_be_live. Refused with 409 publication_is_live when the network itself reported the post — confirm it instead. Ignored for a publication that is still open.

Response

Field
Type
Always
Description
id
string
•
Publication id.
text
string
•
The exact text that will be published to this channel — markdown already flattened to plain network text at schedule time. Not the markdown source; that stays on the post.
media
array
•
The media asset ids this publication sends — the output's own list, or the post's when the output inherits — copied when it was scheduled. What the adapter uploads, character for character.
state
string
•
pending (queued) -> publishing (the reminder was sent; a person is publishing by hand) -> published (confirmed) | failed | cancelled.
fields
object
•
The network variant fields it goes out with — a YouTube title, a Reddit subreddit — copied from the post's approved output when it was scheduled.
postId
string
•
The post being published.
costUsd
number
•
What publishing this costs in USD, computed when it was scheduled. On X a post carrying a link costs 13x a plain one. Null means the cost is not known — an auto channel refuses to dispatch it.
warning
string
•
Set on a published publication when something did not go as asked but the post is out — e.g. YouTube refused the cover as the thumbnail (an unverified channel, a file too large). The post is NOT retried; fix it on the network by hand. Null otherwise.
attempts
integer
•
How many dispatch attempts have been made.
postType
string
•
The post type this publication goes out as (video, short, reel, post, ...), copied from the post's approved variant when it was scheduled. Null on a publication scheduled before post targets existed.
channelId
string
•
The channel it is published to.
costBasis
string
•
Which rate produced costUsd: `plain` the flat per-post rate, `link` the higher rate a post carrying a link is charged, `free` a channel whose rates are both zero. Null when the cost is not known.
createdAt
string
•
ISO-8601 creation time.
lastError
string
•
The most recent failure, if any.
updatedAt
string
•
ISO-8601 time of the last change.
variantId
string
•
The post output this publication is bound to (targets[].id). One live publication per post × channel × output. A publication scheduled before outputs existed carries the channel's network name.
externalId
string
•
The network's id for the published post, once known.
externalUrl
string
•
URL of the published post, once known.
publishedAt
string
•
ISO-8601 time it was confirmed published.
scheduledAt
string
•
ISO-8601 time the publication is due.
coverMediaId
string
•
The output's cover image asset id, copied when it was scheduled, or null for none. YouTube sets it as the video's thumbnail after the upload; a reminder links it for the person publishing by hand.
publicationId
string
•
The publication id again, under the name the content/publication.settled event uses to report this publication finishing. Always identical to id.
reminderCount
integer
•
How many reminders have been sent for this publication.
idempotencyKey
string
•
The key that makes a retry the same publication.
reminderSentAt
string
•
ISO-8601 time the most recent reminder went out, or null if none has.

Try it

Cancel a publication that has not finished.

When to use

Cancel a publication that has not finished. A publication whose reminder already went out can still be cancelled — until someone confirms it. An auto publication that is being sent to the network right now is refused with 409 publication_in_flight: wait for its outcome. A finished publication that may still be live (its output is uncertain) blocks the output until a person settles it: confirm it if the post is on the network, or cancel it with checkedNotLive: true after checking that it is not.

Example

Ask your agent something like this:

Cancel a publication that has not finished.

The agent will invoke content_publications_cancel with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select