Skip to content

Cancel your pending publication schedule for a post

DELETE
/posts/{id}/publication-schedule

Cancels the publication schedule you set for one of your posts, if it’s still marked as waiting. The post itself doesn’t change: a draft stays a draft, and a post that was already published stays published.

You need to be signed in, the post must be one you can read (404 otherwise, deleted posts included), and you must be its author (403). You don’t need the posts.publish capability, so you can cancel after losing it. Other scheduled actions on the same post aren’t touched.

A schedule whose time has passed can still be cancelled while it’s marked as waiting. If the background job is running it at that moment, the cancel waits and then usually finds nothing left to cancel. A schedule can stay marked as waiting after the job has published the post, so a successful cancel doesn’t mean the post wasn’t published, and cancelling never unpublishes it. When there’s no waiting schedule, including on a second cancel, the answer is 404.

id
required
string format: uuid

The post’s id.

The cancelled schedule, with state set to cancelled.

A post’s publication schedule as these routes return it.

object
id
required

The schedule’s id. A replacement gets a new id.

string format: uuid
post_id
required

The post this schedule publishes.

string format: uuid
scheduled_for
required

When the post becomes due to publish. A background job normally checks for due schedules about every five minutes, so the post is published some time after this, if the publish checks pass then; there’s no deadline.

string format: date-time
state
required

pending while the schedule is marked as waiting, which doesn’t by itself mean the post is still unpublished; the cancel route returns cancelled. These routes never return done or failed: a schedule marked as finished is no longer shown here.

string
Allowed values: pending done cancelled failed
created_by
required

The author who scheduled it; always the requesting user.

integer format: int64
created_at
required

When the schedule was saved.

string format: date-time

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

You can’t read the post, or it has no waiting schedule of yours.

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Unexpected server error

object
error
required

Human-readable error summary

string
Example
the request could not be completed