API reference · Posts

Edit a scheduled post or a draft

PATCH /v1/posts/{id}

Edit a post that has not gone out. For a scheduled post, `accounts` replaces the exact destination list at least 30 seconds before publishing. Include `expectedAccounts` from your last GET so a stale edit cannot overwrite a newer destination change. Existing matching targets are preserved and new destinations inherit the publish time after preflight validation. Guardrails apply; approval-required agents must ask the owner. `targetAccounts` repairs a disconnected target by exact replacement. A draft may remain incomplete until published.

Request

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

curl -X PATCH https://api.postlake.dev/v1/posts/{id} \
  -H "Authorization: Bearer $POSTLAKE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"…","campaign":"…","assetMetadata":{},"textOverrides":{}}'

Parameters

FieldTypeRequiredWhat it is
idstringYesIn the URL.

Body

FieldTypeRequiredWhat it is
textstringNo
campaignstringNoOptional campaign slug. Set null to clear.
assetMetadataobjectNoOptional caller-defined asset facts. Set null to clear.
textOverridesobjectNo
scheduledAtstringNo
timezonestringNoIANA timezone (e.g. Europe/London).
mediaarray of stringNo
mediaAltarray of stringNo
mediaOverridesobjectNo
mediaAltOverridesobjectNo
platformOptionsobjectNoMerged per platform, so a TikTok title patch does not wipe other TikTok fields.
accountsarray of stringNoExact final acc_ destination list. Scheduled posts require at least one connected account; new destinations inherit the same publish time.
expectedAccountsarray of stringNoRequired with accounts on scheduled posts. The current target account ids from GET /v1/posts/{id}, in order. Rejects stale edits.
targetAccountsobjectNoScheduled posts only. Map a disconnected target's old acc_ id to the exact replacement connected acc_ id.
threadarray of stringNoDrafts only. New follow-on post bodies. An empty array removes the thread.
firstCommentstringNoDrafts only. New first comment. An empty string removes it.
firstCommentOverridesobjectNoDrafts only. New per-platform first-comment overrides.

Response

Success (200).

Example

"…"

Limits

Write operations are limited per account, and rate-limit responses include Retry-After. Do not automatically retry a write unless this operation explicitly documents idempotency.

Calling this from an agent

Agents do not call REST. They call tools. Over the hosted MCP server this operation is list_posts, 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 list_posts 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