Update a section

Updates a section, the top-level grouping in your help center navigation.

PATCH /v1/sections/{id}

Bearer token scope content:write

curl 'https://api.ferndesk.com/v1/sections/art_01JXY9AZK4KV' \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Guides",
  "slug": "guides",
  "iconData": {
    "type": "huge",
    "id": "book-01"
  }
}'

{
  "id": "sect_01JXYA4T1JNT",
  "helpdeskId": "help_01JXYA7B3T7G",
  "name": "Guides",
  "iconData": {
    "type": "huge",
    "id": "book-01"
  },
  "isDefault": false,
  "position": 1,
  "createdAt": "2026-01-15T18:25:43.511Z",
  "updatedAt": "2026-01-15T18:25:43.511Z",
  "translations": []
}

Updated section

Path parameters

· 1

id string required

Identifier of the requested resource.

Body

required application/json

name string · min length: 1

New section name.

slug string · min length: 1

New URL slug.

iconData any

New icon for the section, or null to clear it.

Path parameters

Body

Responses