Sign in
posts

Update a post by ID

Update an existing post in your publication. The publication is identified by the API key provided in the Authorization header.

Behavior:

  • Only provided fields are updated; omitted fields remain unchanged
  • When markdown is provided, it replaces the full content. Rich blocks (embeds, buttons, callouts) created in the editor will be lost — the markdown to editor conversion is lossy for blocks without a markdown equivalent
  • Set status to "published" to publish a draft, "draft" to unpublish, or "archived" to archive
put/v1/posts/{postId}

Path parameters

postIdstring required

Unique identifier of the post to update

Request body

markdownstring

Post content in Markdown format. Replaces full content — rich blocks created in the editor will be lost

titlestring

Title of the post

subtitlestring

Optional subtitle or brief summary

slugstring

URL-friendly identifier for the post

postPreviewstring

Preview text for the post

status'draft' | 'published' | 'archived'

Set to 'published' to publish, 'draft' to unpublish, or 'archived' to archive

Response

Post updated successfully

successtrue required

Whether the update succeeded

Changes