Changelog-Eintrag erstellen

Erstellt einen Eintrag als Entwurf, der bereit ist, von jemandem in Ferndesk geprüft, bearbeitet und veröffentlicht zu werden. Übergeben Sie publish: true (mit content:publish), um ihn sofort live zu schalten.

POST /v1/changelogs/{id}/entries

Bearer-Token Scope content:write

curl 'https://api.ferndesk.com/v1/changelogs/art_01JXY9AZK4KV/entries?format=markdown' \
  --request POST \
  --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": [
    "new",
    "improved"
  ],
  "announce": false,
  "publish": false
}'

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

Eintrag erstellt; sein Body befindet sich bis zur Veröffentlichung in draft

Pfadparameter

· 1

id string erforderlich

Bezeichner der angeforderten Ressource.

Query-Parameter

· 1

format string · Standard: html· Enum

Welches Body-Feld befüllt werden soll: contentHtml, contentMarkdown oder das verlustfreie contentJson.

Werte

html
markdown
json

Body

erforderlich application/json

title string · min length: 1 erforderlich

Titel des Eintrags.

markdown string

Body als Markdown, in Rich Text konvertiert; nicht zusammen mit content akzeptiert.

content any

Body als Tiptap-Dokument; nicht zusammen mit markdown akzeptiert.

date string · Muster

Auf dem Eintrag anzuzeigendes Datum, YYYY-MM-DD. Weglassen, um den Tag der Veröffentlichung zu verwenden.

tags array of string · max items: 4

Tags für den Eintrag. Duplikate werden ignoriert.

Werte

new
improved
fixed
breaking

announce boolean · Standard: false

Kündigt den Eintrag im Hilfe-Widget an, sobald er live ist. Wenn eine Person den Eintrag in Ferndesk veröffentlicht, bittet der Editor sie, diese Auswahl zu bestätigen.

publish boolean · Standard: false

Veröffentlicht den Eintrag im selben Aufruf (erfordert content:publish). Standardmäßig bleibt er als Entwurf für die Prüfung durch eine Person in Ferndesk bestehen.

Pfadparameter

Query-Parameter

Body

Antworten