---
title: "Cancel a scheduled post"
method: POST
path: "/posts/{id}/cancel"
tags: ["Posts"]
---

# Cancel a scheduled post

`POST /posts/{id}/cancel`

## Request

- Base URL: `https://api.deploy.social/v1`
- URL: `https://api.deploy.social/v1/posts/{id}/cancel`
- Auth: HTTP bearer

Stops a scheduled post from going out. A post that is publishing can be canceled too while every destination it has left is still `waiting` (a platform's daily limit, say); the ones that already posted stay up. Once a destination has started uploading, the post can't be canceled.

## Path parameters

- `id` string, required: Starts with `post_`.

## Headers

- `Idempotency-Key` string: Any unique string, like a UUID. Send the same request again with the same key within 24 hours and you get the first response back instead of a second post.

## Response `200`

The post, now canceled.

- Post
  - `id` string, required: The post's id. Starts with `post_`.
  - `status` string, required: `draft`, `scheduled`, `publishing`, `published`, `partially_published`, `failed` or `cancelled`. New values may be added.
  - `kind` string, required: `video`, `photos` or `text`. New values may be added.
  - `media_id` string, nullable, required: The video's id. Starts with `media_`.
  - `media` PostMediaItem[], required: The photos, in order. Empty for `video` and `text` posts.
    - `media_id` string, nullable, required: The photo's id. Starts with `media_`.
    - `position` integer, required: Where this photo sits in the post, starting at 0.
    - `alt_text` string, nullable, required
  - `caption` string, required
  - `title` string, nullable, required
  - `description` string, nullable, required
  - `tags` string[], nullable, required
  - `first_comment` string, nullable, required
  - `scheduled_at` string, date-time, nullable, required: When it's set to go out.
  - `notify_email` boolean, required
  - `created_via` string, required: Where it was made: `app` (the web app), `mobile` (the phone app), `api` or `mcp`.
  - `created_at` string, date-time, required: When it was created.
  - `updated_at` string, date-time, required: When it last changed.
  - `destinations` PostDestination[], required
    - `destination_id` string, required: The destination's id. Starts with `dest_`.
    - `platform` string, required
    - `handle` string, required
    - `caption` string, nullable, required: This destination's own caption. `null` means it uses the post's.
    - `title` string, nullable, required
    - `description` string, nullable, required
    - `tags` string[], nullable, required
    - `first_comment` string, nullable, required
    - `options` object, required: The settings this destination posts with, defaults included.
    - `status` string, required: `pending`, `publishing`, `published`, `failed` or `cancelled`. New values may be added.
    - `progress` object, nullable, required
      - `phase` string, nullable, required: What's happening right now, like `uploading` or `waiting`. For display only.
      - `percent` integer, nullable, required
    - `url` string, nullable, required: The post on the platform, once it's live.
    - `platform_post_id` string, nullable, required
    - `published_at` string, date-time, nullable, required: When it went live here.
    - `warning` string, nullable, required: It posted, but something didn't go as planned (a first comment that couldn't be added, say).
    - `failure` object, nullable, required
      - `category` string, required: `user`, `platform`, `internal` or `unknown`. New values may be added.
      - `code` string, nullable, required: The platform's own code for it, when there is one.
      - `message` string, required: What happened and what to do, in a sentence you can show a person.
      - `action` string, required: `reconnect`: reconnect the account in Deploy, then retry. `retry`: try again. `none`: retrying won't help.
  - `review_url` string: Drafts only: opens the draft in Deploy, to check it over and post it from there.
  - `issues` PostIssue[]: Drafts only: what still needs fixing before it can go out.
    - `path` string, required
    - `code` string, required
    - `message` string, required
    - `severity` 'error' | 'warning', required: `error` has to be fixed before the post can go out. `warning` won't stop it.

## Other responses

- `400`: The request body isn't valid JSON, or a header is malformed.
- `401`: The API key is missing, wrong, revoked or expired: `missing_api_key`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`.
- `403`: The key can't do this: `insufficient_scope` (a read-only key), `plan_required`, `usage_limit_exceeded` (this month's videos are used up), `access_revoked` (its creator left the workspace), `workspace_archived`.
- `404`: Nothing with this id in the key's workspace.
- `409`: The post or video isn't in a state that allows this right now: `invalid_state` (detail code `media_expired` when the video's files were removed; upload it again), `media_not_ready` (with `Retry-After`), `idempotency_key_in_progress`.
- `422`: Something in the request needs fixing. `details` lists each problem and where it is: `validation_failed`, or `idempotency_key_reused` when a key is sent again with a different request.
- `429`: Slow down and wait `Retry-After` seconds. Either this key has used its requests for the minute (Standard: 60 reads and 20 writes, Studio: 120 and 30), or, when publishing or scheduling, the plan's API posts for the day are used (detail code `daily_post_limit`; Standard: 30 a day across your account, Studio: 100 a day per workspace; `Retry-After` runs to midnight UTC). Posts made in the app never count.
- `500`: Something broke on our side. Retry, and contact us with the request id if it keeps happening.
- `503`: We can't take the request right now. Retry shortly.

---

[API](https://skmtc.dev/deploy/apis/deploy-social-api.md) · [All operations](https://skmtc.dev/deploy/apis/deploy-social-api/llms.txt) · [OpenAPI document](https://skmtc.dev/deploy/apis/deploy-social-api/revisions/7ed97bdd207f?raw)