Crear una entrada de changelog

Crea una entrada como borrador, lista para que alguien la revise, edite y publique en Ferndesk. Pasa publish: true (con content:publish) para publicarla de inmediato.

POST /v1/changelogs/{id}/entries

Token Bearer ámbito 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"
  }
}

Entrada creada; su cuerpo está en draft hasta que se publique

Parámetros de ruta

· 1

id string obligatorio

Identificador del recurso solicitado.

Parámetros de consulta

· 1

format string · por defecto: html· enumeración

Campo del cuerpo que se debe completar: contentHtml, contentMarkdown o el contentJson sin pérdida.

valores

html
markdown
json

Cuerpo

obligatorio application/json

title string · min length: 1 obligatorio

Título de la entrada.

markdown string

Cuerpo en Markdown, convertido a texto enriquecido; no se acepta junto con content.

content any

Cuerpo como documento Tiptap; no se acepta junto con markdown.

date string · patrón

Fecha que se mostrará en la entrada, YYYY-MM-DD. Omítela para usar el día en que se publique la entrada.

tags array of string · max items: 4

Etiquetas de la entrada. Los duplicados se ignoran.

valores

new
improved
fixed
breaking

announce boolean · por defecto: false

Anuncia la entrada en el widget de ayuda una vez que esté publicada. Cuando una persona publica la entrada en Ferndesk, el editor le pide confirmar esta opción.

publish boolean · por defecto: false

Publica la entrada en la misma llamada (requiere content:publish). De forma predeterminada, se deja como borrador para que una persona la revise en Ferndesk.

Parámetros de ruta

Parámetros de consulta

Cuerpo

Respuestas