Ferndesk

Borradores de artículos

Actualizar un borrador de artículo

Actualiza un borrador abierto. El servicio aplica la propiedad del borrador: modificar un borrador propiedad de otro redactor devuelve 409 draft_conflict. Requiere el alcance content:write.

Alcance requerido: content:write

PATCH /articles/{id}/drafts/{draftId}

Actualizar un borrador de artículo

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>"
}

Borrador actualizado

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página Configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, dejar de publicar, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de la asignación de alcances tienen alcances nulos = acceso total (modo heredado).

Path Parameters

  • draftId string obligatorio

    ID del borrador. Ejemplo: drft_01JXY9AZK4KV

  • id string obligatorio

    ID del artículo de Ferndesk (art_...). Ejemplo: art_01JXY9AZK4KV

Request Body

application/json
  • title string
  • content any

    Carga útil del documento JSON. Para los artículos, normalmente es un objeto de texto enriquecido de estilo ProseMirror/Tiptap. Los valores src de los nodos de imagen pueden ser rutas de recursos de Ferndesk, URL de imágenes externas o valores data:image/...;base64,...; las URL externas y las imágenes en base64 se cargan y se reescriben como rutas de recursos de Ferndesk al escribir.

  • markdown string

Response

application/json
  • id string

    ID del borrador.

  • language string | null

    Idioma del borrador.

  • status string

    Estado del borrador.

  • baseVersion integer

    Versión del artículo en la que se basó el borrador.

  • source string | null

    Canal de escritura que creó el borrador.

  • stale boolean

    Indica si el artículo ha avanzado desde que se creó el borrador (solo borradores principales).

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.