Update a collection

Updates a collection’s wording or its position in the help center navigation.

PATCH /v1/collections/{id}

Bearer token scope 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": []
}

Updated collection

Path parameters

· 1

id string required

Identifier of the requested resource.

Body

required application/json

title string · min length: 1

New collection title.

subtitle string | null

New supporting line, or null to clear it.

sectionId string

Section to move the collection into.

parentCollectionId string | null

Collection to nest under, or null to move it to the root.

Path parameters

Body

Responses