Ferndesk

Colecciones

Eliminar una colección

Elimina una colección. Los artículos que contiene se envían a la papelera en cascada (se puede revertir mediante la restauración del artículo). Requiere el ámbito content:write; si la colección contiene artículos PUBLISHED, eliminarla deja el contenido activo fuera de línea y requiere además content:publish.

Ámbito requerido: content:write

DELETE /collections/{id}

Eliminar una colección

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

Eliminada

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 Developer settings.

    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, anular la publicación, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)
    • analytics:read: Leer informes, analíticas 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

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la configuración de ámbitos tienen ámbitos nulos = acceso completo (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string
  • deleted boolean