Mettre à jour une entrée de changelog

Les modifications du titre et du corps sont préparées dans un brouillon et prennent effet lorsque l’entrée est publiée. La date, les tags et announce s’appliquent immédiatement, y compris pour une entrée publiée.

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

Jeton Bearer portée 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"
  }
}

Entrée mise à jour

Paramètres de chemin

· 2

id string requis

Identifiant du changelog (les changelogs sont des collections, il s’agit donc d’un identifiant de collection).

entryId string requis

Identifiant de l’entrée (les entrées sont des articles, il s’agit donc d’un identifiant d’article).

Paramètres de requête

· 1

format string · par défaut : html· énumération

Champ du corps à renseigner : contentHtml, contentMarkdown ou le champ sans perte contentJson.

valeurs

html
markdown
json

Corps

requis application/json

title string · min length: 1

Nouveau titre, préparé dans le brouillon.

markdown string

Nouveau corps au format Markdown, préparé dans le brouillon ; non accepté avec content.

content any

Nouveau corps sous forme de document Tiptap, préparé dans le brouillon ; non accepté avec markdown.

date string | null

Date à afficher, appliquée immédiatement. La valeur null l’efface ; l’entrée utilise alors sa date de publication.

tags array of string · max items: 4

Remplace les tags, appliqués immédiatement. Une liste vide les efface.

valeurs

new
improved
fixed
breaking

announce boolean

Active ou désactive l’annonce du widget, appliquée immédiatement.

Paramètres de chemin

Paramètres de requête

Corps

Réponses