Créer une entrée de changelog

Crée une entrée en tant que brouillon, prête à être relue, modifiée et publiée dans Ferndesk. Transmettez publish: true (avec content:publish) pour la rendre immédiatement publique.

POST /v1/changelogs/{id}/entries

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

Entrée créée ; son corps se trouve dans draft jusqu’à sa publication

Paramètres de chemin

· 1

id string requis

Identifiant de la ressource demandée.

Paramètres de requête

· 1

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

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

valeurs

html
markdown
json

Corps

requis application/json

title string · min length: 1 requis

Titre de l’entrée.

markdown string

Corps au format Markdown, converti en texte enrichi ; non accepté avec content.

content any

Corps sous forme de document Tiptap ; non accepté avec markdown.

date string · motif

Date à afficher sur l’entrée, YYYY-MM-DD. Omettez-la pour utiliser le jour de publication de l’entrée.

tags array of string · max items: 4

Tags de l’entrée. Les doublons sont ignorés.

valeurs

new
improved
fixed
breaking

announce boolean · par défaut : false

Annonce l’entrée dans le widget d’aide dès sa publication. Lorsqu’une personne publie l’entrée dans Ferndesk, l’éditeur lui demande de confirmer ce choix.

publish boolean · par défaut : false

Publie l’entrée dans le même appel (nécessite content:publish). Par défaut, elle reste en tant que brouillon afin d’être relue par une personne dans Ferndesk.

Paramètres de chemin

Paramètres de requête

Corps

Réponses