Help Center API Reference

Update an API reference version

Updates the settings of a version. Send only the fields to change.

PATCH

/v2/help_center/api_specs/{specId}

curl --request PATCH \
  --url https://do.featurebase.app/v2/help_center/api_specs/{specId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isDefault": true,
  "name": "Acme API",
  "status": "active",
  "versionLabel": "v2",
  "versionSlug": "v2",
  "visibleBy": [
    "everyone"
  ]
}
'

{
  "apiSlug": "default",
  "createdAt": "2026-10-01T12:00:00.000Z",
  "draftRevision": 8,
  "hasDraft": true,
  "helpCenterId": "ox6qrqprmsuqaunj",
  "id": "66f7d0c1a2b3c4d5e6f70812",
  "isDefault": true,
  "lastSync": {
    "code": "<string>",
    "createdAt": "2026-10-01T12:00:00.000Z",
    "error": "<string>",
    "finishedAt": "2026-10-01T12:00:00.000Z",
    "revision": 8,
    "status": "draft",
    "syncId": "0f7c3a1e-8d1b-4a53-9a51-3f7a1c9e2b4d"
  },
  "liveOperationCount": 42,
  "liveRevision": 7,
  "name": "Acme API",
  "object": "help_center_api_spec",
  "source": {
    "autoSync": false,
    "lastError": "<string>",
    "lastFetchedAt": "2026-10-01T12:00:00.000Z",
    "type": "api",
    "url": "https://api.acme.com/openapi.json"
  },
  "status": "active",
  "updatedAt": "2026-10-01T12:00:00.000Z",
  "versionLabel": "v2",
  "versionSlug": "v2",
  "visibleBy": [
    "everyone"
  ]
}

name, versionLabel: shown in the help center.
versionSlug: only before the first publish.
visibleBy: who can see the version (["everyone"] or role / segment ids, like articles).
status: active, deprecated (banner, not indexed) or archived (hidden). The default version cannot be archived; restoring an archived version counts against the plan limit.
isDefault: true: make this version the default. It must be published and not archived.

The changes apply in this order: fields, status, default. Each step is in the audit log.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

specIdstringrequired

The API reference version (id from the list).

Example: 66f7d0c1a2b3c4d5e6f70812

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

isDefaultenum<boolean>

Make this version the default (shown without a version prefix). Only a published, not archived version can be the default.

Available options: true

Example: true

namestring

Name of the API reference.

Required string length: 1 - 128

Example: Acme API

statusenum<string>

active, deprecated (shown with a banner, not indexed) or archived (hidden from readers). The default version cannot be archived.

Available options: active, deprecated, archived

Example: active

versionLabelstring

Label of this version in the version picker.

Required string length: 1 - 64

Example: v2

versionSlugstring

URL slug of this version (lower case). It cannot change after the first publish.

Required string length: 1 - 32

Example: v2

visibleBystring[]

Who can see this version in the help center: everyone, or a list of role / segment ids (the same values as visibleBy on articles).

Required array length: 1 - 200

Response

Success

apiSlugstringrequired

The API this version belongs to.

Example: default

createdAtstring | nullrequired

When the version was created.

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

draftRevisionnumber | nullrequired

The revision that waits for review. Null = no draft.

Example: 8

hasDraftbooleanrequired

A draft waits for review (see the draft endpoint).

Example: true

helpCenterIdstringrequired

The help center.

Example: ox6qrqprmsuqaunj

idstringrequired

The API reference version id (specId).

Example: 66f7d0c1a2b3c4d5e6f70812

isDefaultbooleanrequired

The default version (no version prefix in URLs).

Example: true

lastSyncobject | nullrequired

The newest CI push or API import of this version.

Show child attributes

liveOperationCountnumber | nullrequired

Endpoints in the live revision (list only; null otherwise).

Example: 42

liveRevisionnumber | nullrequired

The published revision. Null = never published.

Example: 7

namestringrequired

Name of the API reference.

Example: Acme API

objectenum<string>required

Object type identifier

Available options: help_center_api_spec

Example: help_center_api_spec

sourceobjectrequired

Where the spec comes from.

Show child attributes

statusenum<string>required

Version status.

Available options: active, deprecated, archived

Example: active

updatedAtstring | nullrequired

When the version was last changed.

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

versionLabelstringrequired

Label in the version picker.

Example: v2

versionSlugstringrequired

URL slug of the version.

Example: v2

visibleBystring[]required

Who can see this version.

Still need help? Ask the team