Skip to main content
Help Center API Reference

Publish the draft

Publishes the draft you reviewed. Send its revision as draftRevision and its baseRevision.

POST
/v2/help_center/api_specs/{specId}/publish

The call fails with 409 when a newer draft arrived or the live revision changed since you read the draft: read the draft again. The help center and search update within a minute.

Authentication

Use an organization API key from the dashboard. OAuth and MCP tokens cannot call this endpoint.

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

application/json
baseRevisioninteger | nullrequired

The baseRevision of that draft (the live revision it was compared with; null for a first import).

Required range: 1 <= x
Example: 7
draftRevisionintegerrequired

The revision of the draft you reviewed.

Required range: 1 <= x
Example: 8

Response

application/json

Success

idstringrequired
Example: 66f7d0c1a2b3c4d5e6f70812
liveRevisionnumber | nullrequired

The live revision now.

Example: 8
objectenum<string>required
Available options: help_center_api_spec
Example: help_center_api_spec

Still need help? Ask the team