API Docs/Reference/Cancel Scheduled Post
API Reference

Cancel Scheduled Post

Cancel a scheduled post and return its draft to the unscheduled state. Requires a paid Creator or Lifetime plan.

DELETEhttps://api.linkedmash.com/v1/queue/{scheduleId}

DELETE /v1/queue/{scheduleId} cancels a scheduled post. The queue entry is removed and the underlying draft returns to the unscheduled state — the text is not deleted, so the same draft can be scheduled again later.

scheduleId is the id from the schedule response or from GET /v1/queue, not the draft id. Passing a draft id here will not match anything.

Example request

Authenticate with a bearer token in the Authorization header. Create a key on the API page in your LinkedMash settings and export it as LINKEDMASH_API_KEY before running this.

curl
curl -X DELETE "https://api.linkedmash.com/v1/queue/sch_3a9f81d2" \
  -H "Authorization: Bearer $LINKEDMASH_API_KEY"

Path parameters

scheduleIdstringRequired

The id of the scheduled entry to cancel.

Header parameters

AuthorizationstringRequired

Your secret API key as a Bearer token.

Response

{
  "status": true,
  "data": {
    "id": "sch_3a9f81d2",
    "cancelled": true
  }
}

Response fields

Every response is wrapped in the same envelope: a status flag and a data payload, with meta present where there is pagination or a plan limit to report.

statusboolean

true on success. Every LinkedMash API response carries this envelope flag alongside data, so a client can branch on it without re-reading the HTTP status.

data.idstring

The scheduleId that was cancelled, echoed back.

data.cancelledboolean

true on success. The draft itself survives and returns to the unscheduled set, so it can be scheduled again.

Pulling a post out of the queue

Cancelling is non-destructive, which makes it the right first move whenever timing is in doubt.

1

Find the scheduleId

GET /v1/queue and read entries[].id for the post you want to stop. The draft id will not work here, and there is no lookup from one to the other besides this list.

2

Cancel

The queue entry is removed and the draft returns to the unscheduled set. Nothing about the post body is lost.

3

Decide what happens next

Reschedule it with a fresh POST /v1/posts/{id}/schedule, edit it first with PATCH /v1/posts/{id}, or trash it with DELETE /v1/posts/{id}.

4

Understand what cannot be undone

Once a post has published, its entry is no longer cancellable and this route returns 404. There is no unpublish through the API.

Behaviour and limits

Requires a Creator or Lifetime plan

Everything under /v1/posts, /v1/queue, /v1/schedule, /v1/media and /v1/analytics sits behind one middleware that checks for an unlocked Studio, so a Reader-plan or free key gets 402 with code SUBSCRIPTION_REQUIRED before the handler runs. Bookmark and label reads are on a separate router and are not affected by this gate.

The draft survives

Cancelling unschedules; it does not trash. The draft reappears in GET /v1/posts?status=draft and can be rescheduled with a fresh call to POST /v1/posts/{id}/schedule.

Response is a confirmation, not the record

A successful cancel returns { id, cancelled: true } with the scheduleId echoed back, rather than the deleted queue entry.

Already-published posts cannot be cancelled

Once a post has gone out its queue entry is no longer cancellable and the call returns 404. There is no unpublish.

Errors

Failures carry the same envelope as a success, with the reason in message and a stable machine-readable code where the status alone is ambiguous — several distinct conditions share a 402.

Status
Meaning
401Unauthorized
The Authorization header is missing or the key is not a valid LinkedMash API key. Create or rotate keys on the API page in your LinkedMash settings.
402Payment Required
Returned with code SUBSCRIPTION_REQUIRED. The content API requires a Creator or Lifetime plan; Reader and free accounts get this on every /v1/posts, /v1/queue, /v1/schedule, /v1/media and /v1/analytics call.
404Not Found
No cancellable queue entry with that scheduleId on this account.
500Server Error
Something failed on our side. The body carries message "Failed to cancel the scheduled post". Retry once; if it persists the request is not the problem.