API reference · Posts

Cancel only a scheduled post, with optional preview fencing

POST /v1/posts/{id}/cancel

Never retracts a published post. Preview with dryRun=true, then apply with the returned snapshot to fence all stored fields. Execution uses a full-post compare-and-swap even when a snapshot is omitted.

Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

curl -X POST https://api.postlake.dev/v1/posts/{id}/cancel \
  -H "Authorization: Bearer $POSTLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dryRun":true,"snapshot":"…"}'

Parameters

FieldTypeRequiredWhat it is
idstringYesIn the URL.

Body

FieldTypeRequiredWhat it is
dryRunbooleanNo
snapshotstringNo

Response

Preview snapshot or scheduled post cancelled (200).

FieldTypeRequiredWhat it is
idstringYes
cancelledbooleanYes
dryRunbooleanNo
snapshotstringNo

Example

{
  "id": "…",
  "cancelled": false,
  "dryRun": false,
  "snapshot": "…"
}

What it costs

One credit per network the post actually reaches. X uses dedicated rates: 8 credits for text and 90 for a post with a link. Nothing is charged for a target that fails, and a post refused by pre-flight never touches the ledger at all.

Publishing endpoints are limited to 60 requests a minute per account, inside a wider ceiling of 600 a minute across the whole API. Every response carries X-RateLimit-Remaining and X-RateLimit-Reset.

Calling this from an agent

Agents do not call REST. They call tools. Over the hosted MCP server this operation is create_post, and the agent authorises with OAuth so your API key is never pasted into a chat or seen by the model. The reply comes back in the same normalised shape you see above, which is what lets an agent reason about it without a per-network branch.

You control what any one agent may do with it: which brands it may act for, which networks it may reach, how much it may do in a day, and whether it may spend credits you bought up front. See the MCP server.

Errors

Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.

Check the result before retrying a write. Only operations that explicitly support idempotency can safely replay an Idempotency-Key.

Common questions

Can an AI agent do this without the REST API?

Yes. Over MCP the same job is the create_post tool. The agent authorises with OAuth, so no API key is pasted into a chat or seen by the model, and the answer comes back in the same normalised shape.

Is it safe to retry this call?

Do not automatically repeat a write after a timeout unless that endpoint explicitly documents idempotency. First read the resulting state; a second request could repeat the action.

What happens when it fails?

You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.

Related