Actualizar un artículo

Actualiza un artículo. Los metadatos y la ubicación se aplican de inmediato; las ediciones de contenido se preparan en un borrador abierto que se publica por separado.

PATCH /v1/articles/{id}

Token Bearer ámbito content:write

curl 'https://api.ferndesk.com/v1/articles/art_01JXY9AZK4KV' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Getting started with API keys",
  "content": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "markdown": "# Getting started\n\nWelcome to the API.",
  "collectionId": "col_01JXYA6ABN52",
  "sectionId": "sect_01JXYA4T1JNT",
  "keywords": "api, auth, keys",
  "metaDescription": "Learn how to create and rotate Ferndesk API keys.",
  "ogImage": "https://cdn.ferndesk.com/og/getting-started.png",
  "listed": "unlisted",
  "noindex": false,
  "layout": "full",
  "slug": "getting-started-api-keys"
}'

{
  "id": "art_01JXY9AZK4KV",
  "title": "Getting started with API keys",
  "slug": "getting-started-api-keys",
  "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
  "contentMarkdown": "# Welcome to the Ferndesk API",
  "contentJson": {
    "type": "doc",
    "content": [
      {
        "type": "paragraph",
        "content": [
          {
            "type": "text",
            "text": "Welcome to Ferndesk."
          }
        ]
      }
    ]
  },
  "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
  "sectionId": "sect_01JXYA4T1JNT",
  "collectionId": "col_01JXYA6ABN52",
  "status": "published",
  "layout": "default",
  "publishedAt": "2026-01-15T18:25:43.511Z",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "published": false,
  "draft_id": "drft_01JXY9AZK4KV",
  "message": "Content staged in draft drft_01JXY9AZK4KV; placement applied."
}

Artículo actualizado

Parámetros de ruta

· 1

id string obligatorio

Identificador del recurso solicitado.

Cuerpo

obligatorio application/json

title string · min length: 1

Nuevo título, preparado en un borrador abierto.

content any

Nuevo cuerpo como documento Tiptap, preparado en un borrador abierto; no se acepta junto con markdown.

markdown string

Nuevo cuerpo como Markdown, preparado en un borrador abierto; no se acepta junto con content.

collectionId string | null

Colección en la que se archivará el artículo; se aplica de inmediato.

sectionId string

Sección en la que se archivará el artículo; se aplica de inmediato.

keywords string

Palabras clave de SEO separadas por comas.

metaDescription string

Descripción meta de SEO.

ogImage string

URL de la imagen de Open Graph.

Parámetros de ruta

Cuerpo

Respuestas