Help Center API Reference

Replace the API tab pages

Replaces the landing article and the sidebar sections of the API tab. Send the full list: sections that are not in the list are removed.

PUT

/v2/help_center/api_pages

curl --request PUT \
  --url https://do.featurebase.app/v2/help_center/api_pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiSlug": "default",
  "helpCenterId": "ox6qrqprmsuqaunj",
  "introArticleId": "7765420",
  "sections": [
    {
      "articleIds": [
        "7765421",
        "7765422"
      ],
      "collectionId": "5928310",
      "id": "a1b2c3d4e5f6",
      "kind": "collection",
      "title": "Guides"
    }
  ]
}
'

{
  "apiSlug": "default",
  "articles": {},
  "collectionIds": [
    "5928310"
  ],
  "collections": {},
  "helpCenterId": "ox6qrqprmsuqaunj",
  "introArticleId": "7765420",
  "object": "help_center_api_pages",
  "sections": [
    {
      "articleIds": [
        "<string>"
      ],
      "collectionId": "<string>",
      "id": "<string>",
      "kind": "collection",
      "title": "<string>"
    }
  ],
  "updatedAt": "2026-10-01T12:00:00.000Z"
}

Every article and collection must be in the same help center. An article can be in one section only. Limits: 20 sections, 100 articles per section, 300 articles in all. A collection section moves that collection from the Documentation tab to the API tab; removing the section moves it back.

Authorizations

Authorizationstringheaderrequired

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

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

apiSlugstring

The API of the help center. Today every help center has one API: default.

Required string length: 1 - 32

Pattern: ^[a-z0-9][a-z0-9-]*$

Example: default

helpCenterIdstring

The help center. Defaults to the active help center of your organization.

Required string length: 1 - 16

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

Example: ox6qrqprmsuqaunj

introArticleIdstring | null

The landing page of the API tab. null = the generated overview.

Required string length: 1 - 16

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

Example: 7765420

sectionsobject[]required

The sidebar sections above the endpoint groups, in order. This list replaces the stored one.

Maximum array length: 20

Show child attributes

Response

Success

apiSlugstringrequired

Example: default

articlesobjectrequired

Labels of the referenced articles (default locale), by article id.

collectionIdsstring[]required

The collections shown in the API tab (from the collection sections), in order.

collectionsobjectrequired

Names of the referenced collections, by collection id.

helpCenterIdstringrequired

Example: ox6qrqprmsuqaunj

introArticleIdstring | nullrequired

The landing page article of the API tab. Null = the generated overview.

Example: 7765420

objectenum<string>required

Available options: help_center_api_pages

Example: help_center_api_pages

sectionsobject[]required

Sidebar sections above the endpoint groups, in order. A collection section moves that collection from the Documentation tab to the API tab.

Show child attributes

updatedAtstring | nullrequired

When the pages were last saved.

Example: 2026-10-01T12:00:00.000Z

Still need help? Ask the team