Skip to main content
PATCH
Update a single post

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

postId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"post_123"

Body

application/json
title
string
Required string length: 1 - 120
Example:

"Ship notes for week 11"

slug
string | null
Required string length: 1 - 160
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"ship-notes-week-11"

markdown
string
Required string length: 1 - 100000
Example:

"# Ship notes\n\nWe shipped a faster editor."

status
enum<string>
Available options:
draft,
published
Example:

"published"

metadata
object

Site metadata for blog posts and changelogs. Send only the fields you want to change. Rejected with 400 for other content types.

Response

Post updated successfully

organization
object
required
post
object
required