Update a changelog entry

Title and body edits are staged into a draft and go live when the entry is published. Date, tags and announce apply immediately, including on a live entry.

PATCH /v1/changelogs/{id}/entries/{entryId}

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/changelogs/col_01JXYA6ABN52/entries/art_01JXY9AZK4KV?format=markdown' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Faster search",
  "markdown": "Search results now load **twice as fast**.",
  "content": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "date": "2026-09-30",
  "tags": [
    "fixed"
  ],
  "announce": true
}'

{
  "id": "art_01JXY9AZK4KV",
  "changelogId": "col_01JXYA6ABN52",
  "title": "Faster search",
  "slug": "faster-search",
  "contentHtml": "<p>Search results now load twice as fast.</p>",
  "contentMarkdown": "Search results now load twice as fast.",
  "contentJson": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "url": "https://docs.example.com/faster-search-A1B2C3",
  "status": "published",
  "date": "2026-09-30",
  "tags": [
    "new"
  ],
  "announce": false,
  "publishedAt": "2026-09-30T14:02:11.000Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "draft": {
    "id": "drft_01JXY9AZK4KV",
    "title": "Faster search",
    "contentHtml": "<p>Search results now load twice as fast.</p>",
    "contentMarkdown": "Search results now load twice as fast.",
    "contentJson": {
      "type": "doc",
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "Welcome to Ferndesk."
            }
          ]
        }
      ]
    },
    "source": "api",
    "updatedAt": "2026-01-15T18:25:43.511Z"
  }
}

Updated entry

Path parameters

· 2

id string required

Changelog identifier (changelogs are collections, so this is a collection id).

entryId string required

Entry identifier (entries are articles, so this is an article id).

Query parameters

· 1

format string · default: html· enum

Which body field to populate: contentHtml, contentMarkdown, or the lossless contentJson.

values

html
markdown
json

Body

required application/json

title string · min length: 1

New title, staged into the draft.

markdown string

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

content any

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

date string | null

Date to show, applied immediately. Null clears it, so the entry uses its publish day.

tags array of string · max items: 4

Replaces the tags, applied immediately. An empty list clears them.

values

new
improved
fixed
breaking

announce boolean

Turns the widget announcement on or off, applied immediately.

Path parameters

Query parameters

Body

Responses