Ferndesk

Artículos

Publicar un artículo

Publica un borrador abierto, convirtiéndolo en la versión activa.

  • Proporcione draft_id para publicar un borrador específico.
  • Omita draft_id solo cuando exista exactamente un borrador abierto propiedad de esta clave de API; de lo contrario, se devuelve no_draft (409).

Las publicaciones obsoletas devuelven 409 con code: draft_outdated y las versiones actual y base para que pueda hacer un rebase. Requiere el ámbito content:publish.

Ámbito requerido: content:publish

POST /articles/{id}/publish

Publicar un artículo

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/publish' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "status": "<string>",
  "version": 1
}

Publicado

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 en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

    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, retirar la publicación, restaurar y eliminar contenido (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 ámbitos tienen ámbitos nulos = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Request Body

application/json
  • draft_id string

    Borrador que se publicará. Opcional solo cuando exista exactamente un borrador abierto propiedad de esta clave de API.

Response

application/json
  • id string

    ID del artículo de Ferndesk (art_...).

  • status string
  • version integer

    Nueva versión del artículo después de la publicación.