Ferndesk

Collections

Supprimer une collection

Supprime une collection. Les articles qu’elle contient sont placés dans la corbeille par cascade (récupérables via la restauration d’article). Nécessite le scope content:write ; si la collection contient des articles PUBLISHED, la suppression met le contenu en ligne hors ligne et nécessite également content:publish.

Scope requis : content:write

DELETE /collections/{id}

Supprimer une collection

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

Supprimée

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et placer du contenu dans la corbeille (rendre les modifications actives)
    • analytics:read : Consulter les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Consulter les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    Accorder content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes null = accès complet (mode hérité).

Path Parameters

  • id string requis

    ID de ressource de l’entité demandée. Exemple: art_01JXY9AZK4KV

Response

application/json
  • id string
  • deleted boolean