Ferndesk

Articles

Publier un article

Publie un brouillon ouvert, qui devient la version active.

  • Fournissez draft_id pour publier un brouillon spécifique.
  • Omettez draft_id uniquement lorsqu’il existe exactement un brouillon ouvert appartenant à cette clé API ; sinon, une erreur no_draft (409) est renvoyée.

Les publications obsolètes renvoient 409 avec code: draft_outdated ainsi que les versions actuelle/de base afin de vous permettre de rebaser. Nécessite la portée content:publish.

Portée requise : content:publish

POST /articles/{id}/publish

Publier un article

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
}

Publié

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 portées (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 actives)
    • analytics:read : Lire les rapports, analyses et 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 null = accès total (mode hérité).

Path Parameters

  • id string requis

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

Request Body

application/json
  • draft_id string

    Brouillon à publier. Facultatif uniquement lorsqu’il existe exactement un brouillon ouvert appartenant à cette clé API.

Response

application/json
  • id string

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

  • status string
  • version integer

    Nouvelle version de l’article après publication.