Ferndesk

Articles

Mettre un article à la corbeille

Met un article à la corbeille (opération réversible). Il disparaît immédiatement des surfaces publiques et de recherche et peut être récupéré via POST /articles/:id/restore jusqu'à sa purge au bout de 30 jours. Requiert la portée content:write ; la mise à la corbeille d'un article PUBLISHED retire le contenu en ligne et requiert également content:publish.

Portée requise : content:write

DELETE /articles/{id}

Mettre un article à la corbeille

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

Mis à la corbeille

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 des portées suivantes (chaque endpoint indique la portée requise 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 mettre à la corbeille du contenu (rendre les modifications visibles)
    • analytics:read : Lire les rapports, les analyses et les retours sur les articles du centre d'aide
    • conversations:read : Lire 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 portées ont des portées nulles = accès complet (mode legacy).

Path Parameters

  • id string requis

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

Response

application/json
  • id string

    ID d'article Ferndesk (art_...).

  • status string