Ferndesk

Borradores de artículos

Crear un borrador de artículo

Crea un borrador abierto para un artículo. Pasa language para un borrador de traducción. Requiere el ámbito content:write.

Ámbito requerido: content:write

POST /articles/{id}/drafts

Crear un borrador de artículo

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts' \
  --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 creado

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 de configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos ámbitos (cada endpoint indica el ámbito 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, anular la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • 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 ámbitos tienen null scopes = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Request Body

application/json
  • title string

    Título del borrador.

  • content any

    Cuerpo del borrador (Tiptap JSON).

  • markdown string

    Cuerpo del borrador en Markdown.

  • language string

    Idioma del borrador de traducción. Omítelo para el idioma principal.

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.