Ferndesk

Brouillons d’articles

Créer un brouillon d’article

Crée un brouillon ouvert pour un article. Indiquez language pour un brouillon de traduction. Nécessite la portée content:write.

Portée requise : content:write

POST /articles/{id}/drafts

Créer un brouillon d’article

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts' \
  --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 créé

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 les brouillons d’articles, les utilisateurs et les tâches ; déplacer les articles et les collections
    • content:publish : Publier, dépublier, restaurer et mettre le contenu à la corbeille (rendre les modifications effectives)
    • 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 null = accès complet (mode hérité).

Path Parameters

  • id string requis

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

Request Body

application/json
  • title string

    Titre du brouillon.

  • content any

    Corps du brouillon (JSON Tiptap).

  • markdown string

    Corps du brouillon au format Markdown.

  • language string

    Langue d’un brouillon de traduction. Omettre pour la langue principale.

Response

application/json
  • id string

    Identifiant 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.