Ferndesk

Brouillons d’articles

Mettre à jour un brouillon d’article

Met à jour un brouillon ouvert. La propriété du brouillon est appliquée par le service : toute modification d’un brouillon appartenant à un autre rédacteur renvoie 409 draft_conflict. Nécessite la portée content:write.

Portée requise : content:write

PATCH /articles/{id}/drafts/{draftId}

Mettre à jour un brouillon d’article

curl --request PATCH \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>"
}

Brouillon mis à jour

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 placer du contenu dans la corbeille (rendre les modifications visibles)
    • 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

    L’attribution de 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 hérité).

Path Parameters

  • draftId string requis

    ID du brouillon. Exemple: drft_01JXY9AZK4KV

  • id string requis

    Identifiant de l’article Ferndesk (art_...). Exemple: art_01JXY9AZK4KV

Request Body

application/json
  • title string
  • content any

    Charge utile d’un document JSON. Pour les articles, il s’agit généralement d’un objet de texte enrichi de type ProseMirror/Tiptap. Les valeurs src des nœuds d’image peuvent être des chemins d’assets Ferndesk, des URL d’images externes ou des valeurs data:image/...;base64,... ; les URL externes et les images encodées en base64 sont téléversées et réécrites en chemins d’assets Ferndesk lors de l’écriture.

  • markdown string

Response

application/json
  • id string

    ID du brouillon.

  • language string | null

    Langue du brouillon.

  • status string

    Statut du brouillon.

  • baseVersion integer

    Version de l’article sur laquelle le brouillon est basé.

  • source string | null

    Canal d’écriture ayant créé le brouillon.

  • stale boolean

    Indique si l’article a évolué depuis la création du brouillon (brouillons principaux uniquement).

  • updatedAt string

    Horodatage ISO 8601 en UTC.