Changelog-Eintrag aktualisieren

Titel- und Inhaltsänderungen werden als Entwurf vorgemerkt und beim Veröffentlichen des Eintrags live geschaltet. Datum, Tags und announce werden sofort angewendet, auch bei einem bereits live geschalteten Eintrag.

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"
  }
}

Aktualisierter Eintrag

Pfadparameter

· 2

id string erforderlich

Changelog-Kennung (Changelogs sind Sammlungen, daher ist dies eine Sammlungs-ID).

entryId string erforderlich

Eintragskennung (Einträge sind Artikel, daher ist dies eine Artikel-ID).

Query-Parameter

· 1

format string · Standard: html· Enum

Welches Inhaltsfeld befüllt werden soll: contentHtml, contentMarkdown oder das verlustfreie contentJson.

Werte

html
markdown
json

Body

erforderlich application/json

title string · min length: 1

Neuer Titel, als Entwurf vorgemerkt.

markdown string

Neuer Inhalt als Markdown, als Entwurf vorgemerkt; nicht zusammen mit content zulässig.

content any

Neuer Inhalt als Tiptap-Dokument, als Entwurf vorgemerkt; nicht zusammen mit markdown zulässig.

date string | null

Anzuzeigendes Datum, wird sofort angewendet. Null entfernt es, sodass der Eintrag seinen Veröffentlichungstag verwendet.

tags array of string · max items: 4

Ersetzt die Tags und wird sofort angewendet. Eine leere Liste entfernt alle Tags.

Werte

new
improved
fixed
breaking

announce boolean

Schaltet die Ankündigung im Widget ein oder aus und wird sofort angewendet.

Pfadparameter

Query-Parameter

Body

Antworten