Update post
update_postDestructiveIdempotent
Update an existing post. Can change content, schedule, media, labels, status, and platform-specific settings. Only draft, scheduled, failed, or partial posts can be edited; editing a failed post resets it to draft, a partial post stays partial. Set status to 'draft' or 'scheduled' to move the post between those states — scheduling a partial post re-queues only its failed channels; use publish_post to publish immediately. Use this when the user wants to edit an existing post.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| postId | Yes | The post ID to update. | |
| status | No | Move the post between draft and scheduled. 'scheduled' requires a future scheduledAt (in this call or already stored) and at least one channel; 'draft' unschedules it. Any other value is rejected. Omit to leave the status unchanged. To publish immediately, use publish_post instead. | |
| content | No | New post text content. | |
| labelIds | No | Replace label IDs on the post. | |
| timezone | No | Timezone for scheduling. | |
| scheduledAt | No | New ISO 8601 scheduled datetime. | |
| mediaFileIds | No | Replace attached media file IDs. | |
| requestApproval | No | Optional (default false). Set true to hold a scheduled post for team approval (approvalStatus becomes 'pending'). Forced on server-side for API keys of roles without post:publish (contributors), regardless of this flag. | |
| platformSpecific | No | Platform-specific settings, e.g. { "youtube": { "title": "…", "privacyStatus": "public" } }. Reddit, Discord, Tumblr and Snapchat nest their options under the BulkPublish channel id, e.g. { "reddit": { "12": { "subreddit": "webdev" } } }. Telegram takes no options. | |
| ifUnmodifiedSince | No | Optional precondition: the post's updatedAt exactly as the last read returned it. The update is refused with 409 CONFLICT if a teammate has changed the post since, rather than overwriting their version. Pass it whenever you read a post before editing it; omit it to keep the previous last-write-wins behaviour. | |
| postTypeOverrides | No | Per-platform post type override. E.g. { "instagram": "reel", "youtube": "short" }. Video length is checked per type when the post is scheduled or published, and a video outside the range is refused: instagram reel/feed_video 3s–15min, story 3–60s; facebook reel 3–90s, story 3–60s; threads video/carousel up to 5min; linkedin 3s–30min; pinterest video_pin at least 4s; snapchat story 5–60s, spotlight 6–60s (saved_story not checked). | |
| publishWhenApproved | No | Optional. Set true to have the post go out as soon as it is approved, even after its scheduled time (see create_post). An explicit value is stored while the post waits for approval. Omitted, it is kept, except that sending a different scheduledAt clears it to false, and it is always false once the post is no longer approvalStatus 'pending'. | |
| linkTrackingOverride | No | Optional per-post override for link tracking (bulkpubli.sh). true forces links in this post to be shortened and their clicks counted, false forces them to publish as written, and null clears the override so the post inherits the organization's Link Tracking setting again. Omit to leave it unchanged. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| author | No | Who wrote the post: { id, name, image }. Null when that account is gone. | |
| labels | No | ||
| status | No | draft, scheduled, processing, published, partial or failed. | |
| content | No | ||
| approver | No | Who approved it: { id, name, image }. Null unless approvalStatus is approved. | |
| assignee | No | Who is expected to act on it next: { id, name, image }. Null when nobody is. | |
| timezone | No | ||
| createdAt | No | ||
| mediaFiles | No | ||
| publishedAt | No | ||
| scheduledAt | No | ||
| postPlatforms | No | ||
| approvalStatus | No |