Ferndesk

Artículos

Enviar un artículo a la papelera

Mueve un artículo a la papelera (reversible). Desaparece inmediatamente de las superficies públicas y de búsqueda, y se puede recuperar mediante POST /articles/:id/restore hasta su eliminación definitiva después de 30 días. Requiere el ámbito content:write; enviar a la papelera un artículo PUBLISHED deja el contenido activo fuera de línea y requiere además content:publish.

Ámbito requerido: content:write

DELETE /articles/{id}

Enviar un artículo a la papelera

curl --request DELETE \
  --url 'https://api.ferndesk.com/v1/articles/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "status": "<string>"
}

En la papelera

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página de configuración para desarrolladores.

    Las claves se pueden restringir 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 enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, analítica 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 completo (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string

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

  • status string