Mettre à jour une collection

Met à jour le texte d’une collection ou sa position dans la navigation du centre d’aide.

PATCH /v1/collections/{id}

Jeton Bearer portée content:write

curl 'https://api.ferndesk.com/v1/collections/art_01JXY9AZK4KV' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Authentication",
  "subtitle": "API key and token flows",
  "sectionId": "sect_01JXYA4T1JNT",
  "parentCollectionId": "col_01JXYA6ABN52"
}'

{
  "id": "col_01JXYA6ABN52",
  "helpdeskId": "help_01JXYA7B3T7G",
  "sectionId": "sect_01JXYA4T1JNT",
  "parentCollectionId": "parent_collection_01JXY9AZK4KV",
  "title": "Authentication",
  "subtitle": "API key and token flows",
  "shortId": "C0L123",
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "translations": []
}

Collection mise à jour

Paramètres de chemin

· 1

id string requis

Identifiant de la ressource demandée.

Corps

requis application/json

title string · min length: 1

Nouveau titre de la collection.

subtitle string | null

Nouvelle ligne descriptive, ou null pour la supprimer.

sectionId string

Section dans laquelle déplacer la collection.

parentCollectionId string | null

Collection sous laquelle imbriquer celle-ci, ou null pour la déplacer à la racine.

Paramètres de chemin

Corps

Réponses