Actualizar una entrada del changelog

Las ediciones del título y el cuerpo se guardan en un borrador y se hacen efectivas cuando se publica la entrada. La fecha, las etiquetas y announce se aplican inmediatamente, incluso en una entrada publicada.

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

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

Entrada actualizada

Parámetros de ruta

· 2

id string obligatorio

Identificador del changelog (los changelogs son colecciones, por lo que este es un id de colección).

entryId string obligatorio

Identificador de la entrada (las entradas son artículos, por lo que este es un id de artículo).

Parámetros de consulta

· 1

format string · por defecto: html· enumeración

Qué campo del cuerpo rellenar: contentHtml, contentMarkdown o el contentJson sin pérdida.

valores

html
markdown
json

Cuerpo

obligatorio application/json

title string · min length: 1

Nuevo título, guardado en el borrador.

markdown string

Nuevo cuerpo en Markdown, guardado en el borrador; no se acepta junto con content.

content any

Nuevo cuerpo como documento Tiptap, guardado en el borrador; no se acepta junto con markdown.

date string | null

Fecha que se mostrará, aplicada inmediatamente. Null la elimina, por lo que la entrada usa el día de publicación.

tags array of string · max items: 4

Reemplaza las etiquetas, aplicadas inmediatamente. Una lista vacía las elimina.

valores

new
improved
fixed
breaking

announce boolean

Activa o desactiva el anuncio del widget, aplicado inmediatamente.

Parámetros de ruta

Parámetros de consulta

Cuerpo

Respuestas