Skip to content

Cancel Scheduled Post API

The Cancel Scheduled Post API lets you cancel a scheduled post by its ID and move it back to draft. Use this operation when a planned post should no longer publish at its scheduled time but should remain available as a draft for later review or editing.

Purpose and outcome

Cancel Scheduled is the operation for removing a scheduled post from its planned publication time. The documented outcome is to move it back to draft, rather than deleting the post content. This distinction matters in client workflows: after a successful cancellation, treat the item as a draft, not as a published or deleted post.

Endpoint and input contract

Send a DELETE request to the endpoint shown in the worked example below, with the scheduled post ID placed in the path as postId. The request example uses the x-access-key header. Before calling, confirm that the identifier you have is the scheduled post ID you intend to cancel, because the operation acts on that single ID and the documented failure cases include a missing post and a post that has already published.

Worked request example

The worked example below shows the request for a scheduled post with the example identifier post_xyz789. Replace that example identifier with the actual scheduled post ID to cancel, and supply your key in the x-access-key header. The example is illustrative and has not been executed as part of this draft.

Success response

A successful cancellation returns success set to true and the message Post cancelled and moved to draft. Check both fields in your client rather than relying only on the HTTP status, so your workflow can confirm the documented outcome before updating local state to draft.

Failure matrix: status codes and next actions

Interpret the status code before deciding what to do next. A 200 means Successfully cancelled, so the post can be treated as moved back to draft. A 404 means Post not found, so verify the postId and do not treat the item as cancelled. A 409 means Post already published, so the scheduled cancellation did not apply to an unpublished scheduled post and the item should be handled as published. No additional status codes, retry behavior, or recovery semantics are documented for this operation, so do not assume them.

Path parameters for Cancel Scheduled
ParameterTypeDescription
postIdstringThe scheduled post ID to cancel

Exact source contract; origin modularized as {{API_BASE_URL}} in examples.

Status codes for Cancel Scheduled
CodeMeaningNext action
200Successfully cancelledTreat the post as moved back to draft.
404Post not foundVerify the postId; do not treat the post as cancelled.
409Post already publishedTreat the post as published; cancellation of a scheduled post did not apply.

Literal source meanings preserved; next actions are limited to interpreting the documented outcome without inventing retry or recovery behavior.

Cancel a scheduled post with cURL
curl -X DELETE "{{API_BASE_URL}}/v1/posts/scheduled/post_xyz789" \
  -H "x-access-key: YOUR_API_KEY"
Success response for cancelling a scheduled post
{
	"success": true,
	"message": "Post cancelled and moved to draft."
}
Contract example 1
DELETE {{API_BASE_URL}}/v1/posts/scheduled/{postId}