Update an article

Updates an article. Metadata and placement apply immediately; content edits are staged into an open draft you publish separately.

PATCH /v1/articles/{id}

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/articles/art_01JXY9AZK4KV' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Getting started with API keys",
  "content": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "markdown": "# Getting started\n\nWelcome to the API.",
  "collectionId": "col_01JXYA6ABN52",
  "sectionId": "sect_01JXYA4T1JNT",
  "keywords": "api, auth, keys",
  "metaDescription": "Learn how to create and rotate Ferndesk API keys.",
  "ogImage": "https://cdn.ferndesk.com/og/getting-started.png",
  "listed": "unlisted",
  "noindex": false,
  "layout": "full",
  "slug": "getting-started-api-keys"
}'

{
  "id": "art_01JXY9AZK4KV",
  "title": "Getting started with API keys",
  "slug": "getting-started-api-keys",
  "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
  "contentMarkdown": "# Welcome to the Ferndesk API",
  "contentJson": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
  "sectionId": "sect_01JXYA4T1JNT",
  "collectionId": "col_01JXYA6ABN52",
  "status": "published",
  "layout": "default",
  "publishedAt": "2026-01-15T18:25:43.511Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "published": false,
  "draft_id": "drft_01JXY9AZK4KV",
  "message": "Content staged in draft drft_01JXY9AZK4KV; placement applied."
}

Updated article

Path parameters

· 1

id string required

Identifier of the requested resource.

Body

required application/json

title string · min length: 1

New title, staged into an open draft.

content any

New body as a Tiptap document, staged into an open draft; not accepted alongside markdown.

markdown string

New body as Markdown, staged into an open draft; not accepted alongside content.

collectionId string | null

Collection to file the article under, applied immediately.

sectionId string

Section to file the article under, applied immediately.

keywords string

Comma-separated SEO keywords.

metaDescription string

SEO meta description.

ogImage string

Open Graph image URL.

Path parameters

Body

Responses