SapanBaseDevelopers

Create a developer-docs version

Always created HIDDEN (status 'draft') and never made default — a human publishes it in HelpBento. With fromVersionId it CLONES that version's pages, sections, and API references into the new one. Scope: content:write.

POSThttps://api.helpbento.com/v1/doc-versions

Authentication

AuthorizationstringheaderBearer <token>required

An API key, e.g. hb_live_… (live) or hb_test_… (test).

Header parameters

1 param
  • Idempotency-Keystringlength: 0…255

    Optional idempotency key (1–255 chars). Repeating a mutating request with the same key within 24h replays the original response instead of re-executing it; a concurrent in-flight request with the same key returns 409. Use a unique key (e.g. a UUID) per logical operation so network retries are safe.

Request body

application/jsonrequired
  • knowledgeBaseIdstringrequired

    A developer-docs KB id (type 'developer_docs').

  • labelstringrequired

    Version label shown in the switcher, e.g. "v2", "2024-01".

  • slugstring

    URL slug; defaults to a slugified label. Cannot be a reserved word (api, search, changelog, …).

  • fromVersionIdstring

    Clone all content from this version (from GET /v1/doc-versions); omit for an empty version.

Responses

  • versionIdstring
  • labelstring
  • slugstring
  • statusstringdraft | beta | stable | deprecated
  • isDefaultboolean
  • copiedobject | null

    Present when cloned from fromVersionId: how much content was copied.

  • manageUrlstring
Errors