Help Centers

Update a collection

Updates an existing collection. Only include the fields you wish to update.

PATCH

/v2/help_center/collections/{id}

Update a collection

curl --request PATCH \
  --url https://do.featurebase.app/v2/help_center/collections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Updated description in English.",
  "icon": {
    "type": "emoji",
    "value": "📝"
  },
  "name": "Updated Collection",
  "parentId": null,
  "translations": {
    "am": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ar": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "az": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "bg": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "bn": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "bs": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ca": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "cs": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "da": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "de": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "el": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "en": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "es": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "et": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "fa": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "fi": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "fr": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "gu": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ha": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "he": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "hi": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "hr": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ht": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "hu": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "id": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ig": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "it": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ja": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "jv": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "kk": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "km": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "kn": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ko": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "lo": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "lt": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "lv": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ml": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "mn": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "mr": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ms": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "my": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "nb": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ne": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "nl": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "pa": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "pl": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ps": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "pt": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "pt-BR": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ro": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ru": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sd": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "si": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sk": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sl": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "so": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sr": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sv": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "sw": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ta": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "te": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "th": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "tl": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "tr": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "uk": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "ur": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "uz": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "vi": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "yo": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "zh-CN": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    },
    "zh-TW": {
      "description": "This is a collection of articles in German.",
      "name": "German Collection"
    }
  }
}
'

{
  "articleCount": 15,
  "authorCount": 3,
  "availableLocales": [
    "en",
    "de"
  ],
  "collapseSidebar": false,
  "createdAt": "2024-10-18T12:33:09.099Z",
  "defaultLocale": "en",
  "description": "A description in English",
  "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version",
  "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version",
  "helpCenterId": "j7c5g8ah3ewxp4lo",
  "icon": {
    "type": "emoji",
    "value": "🥾"
  },
  "id": "6474684",
  "locale": "en",
  "name": "English Collection Name",
  "object": "collection",
  "order": 1,
  "organization": "6595518396205e06b897ad65",
  "parentId": null,
  "path": "ox6qrqprmsuqaunj/3876752/3513543",
  "slug": "6474684-english-version",
  "translations": {
    "am": {},
    "ar": {},
    "az": {},
    "bg": {},
    "bn": {},
    "bs": {},
    "ca": {},
    "cs": {},
    "da": {},
    "de": {},
    "el": {},
    "en": {},
    "es": {},
    "et": {},
    "fa": {},
    "fi": {},
    "fr": {},
    "gu": {},
    "ha": {},
    "he": {},
    "hi": {},
    "hr": {},
    "ht": {},
    "hu": {},
    "id": {},
    "ig": {},
    "it": {},
    "ja": {},
    "jv": {},
    "kk": {},
    "km": {},
    "kn": {},
    "ko": {},
    "lo": {},
    "lt": {},
    "lv": {},
    "ml": {},
    "mn": {},
    "mr": {},
    "ms": {},
    "my": {},
    "nb": {},
    "ne": {},
    "nl": {},
    "pa": {},
    "pl": {},
    "ps": {},
    "pt": {},
    "pt-BR": {},
    "ro": {},
    "ru": {},
    "sd": {},

Path Parameters

id - The unique identifier of the collection to update

Request Body

All fields are optional. Only provided fields will be updated:

name - The new name of the collection
description - The new description of the collection
icon - An updated icon object for the collection (with type and value)
parentId - The new parent collection ID, if applicable (null for root level)
translations - A dictionary of updated translations keyed by locale code

Response

Returns the updated collection object with:

id - Unique identifier
name - Collection name
description - Collection description
slug - URL slug
icon - Collection icon (emoji or custom)
parentId - Parent collection ID (null for root collections)
helpCenterId - ID of the help center this collection belongs to
organization - Organization ID
defaultLocale - Default locale for content
locale - Current locale
availableLocales - Array of available locales
featurebaseUrl - Featurebase URL for the collection
externalUrl - External URL if custom domain is configured
articleCount - Number of articles in this collection
authorCount - Number of authors who contributed
order - Display order
translations - Translations for different locales
createdAt - ISO 8601 timestamp when created
updatedAt - ISO 8601 timestamp when last updated

Errors

404 - Collection not found in your organization's help center

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Path Parameters

idstringrequired

The collection unique identifier

Required string length: 1 - 16

Pattern: ^[a-zA-Z0-9]+$

Example: 3416135

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Body

descriptionstring

The new description of the collection

Maximum string length: 512

Example: Updated description in English.

iconobject | null

An updated icon object for the collection

Show child attributes

namestring

The new name of the collection

Maximum string length: 255

Example: Updated Collection

parentIdstring | null

The new parent collection ID, if applicable

Required string length: 1 - 16

Pattern: ^[a-zA-Z0-9]+$

translationsobject

A dictionary of updated translations keyed by locale

Show child attributes

Response

Success

articleCountnumber

Number of articles

Example: 15

authorCountnumber

Number of authors

Example: 3

availableLocalesenum<string>[]required

Available locales

Whether to collapse sidebar

Example: false

createdAtstringrequired

ISO 8601 timestamp when created

Example: 2024-10-18T12:33:09.099Z

defaultLocaleenum<string>

Default locale

Available options: ar, am, fa, ht, lo, my, pa, ps, so, tl, ur, he, ta, te, mr, gu, kn, ml, ha, jv, yo, ig, uz, ne, sd, az, si, km, kk, bn, bs, pt-BR, bg, ca, hr, cs, da, nl, en, et, fi, fr, de, el, hi, hu, id, it, ja, ko, lv, lt, ms, mn, nb, pl, pt, ro, ru, sr, zh-CN, sk, sl, es, sw, sv, th, zh-TW, tr, uk, vi

Example: en

descriptionstring

Collection description

Example: A description in English

externalUrlstring

External URL

Example: https://help.yourdomain.com/en/collections/6474684-english-version

featurebaseUrlstring

Featurebase URL

Example: https://yourorg.featurebase.app/en/help/collections/6474684-english-version

helpCenterIdstringrequired

Help center ID

Example: j7c5g8ah3ewxp4lo

iconobject | null

Collection icon

Show child attributes

idstringrequired

Collection unique identifier

Example: 6474684

localeenum<string>required

Current locale

Example: en

namestring

Collection name

Example: English Collection Name

objectenum<string>required

Object type identifier

Available options: collection

Example: collection

ordernumber | null

Display order

Example: 1

organizationstringrequired

Organization ID

Example: 6595518396205e06b897ad65

parentIdstring | nullrequired

Parent collection ID

pathstring

Collection path

Example: ox6qrqprmsuqaunj/3876752/3513543

slugstring

URL slug

Example: 6474684-english-version

translationsobject

Translations by locale code

Show child attributes

updatedAtstringrequired

ISO 8601 timestamp when last updated

Example: 2024-10-18T13:03:25.921Z

Still need help? Ask the team