Skip to main content
PATCH
https://api.usenotra.com
/
v1
/
posts
/
{postId}
Update a single post
curl --request PATCH \
  --url https://api.usenotra.com/v1/posts/{postId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Ship notes for week 11",
  "slug": "ship-notes-week-11",
  "markdown": "# Ship notes\n\nWe shipped a faster editor.",
  "status": "published"
}
'
{
  "organization": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "logo": "<string>"
  },
  "post": {
    "id": "<string>",
    "title": "<string>",
    "slug": "<string>",
    "content": "<string>",
    "markdown": "<string>",
    "recommendations": "<string>",
    "contentType": "<string>",
    "status": "draft",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "sourceMetadata": "<unknown>"
  }
}

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY.

Path Parameters

postId
string
required
Minimum string length: 1
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
Minimum string length: 1
Example:

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

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

"published"

Response

Post updated successfully

organization
object
required
post
object
required