SapanBaseDevelopers

Update a version's release notes

Writes a developer-docs version's release notes from Markdown (its built-in per-version changelog). Writing to a HIDDEN 'draft' version is safe; writing to a public version (beta/stable/deprecated) updates the live public /changelog page immediately — that requires confirmLiveUpdate: true after the user agrees (check the version's status via GET /v1/doc-versions first), else this returns 422. Scope: content:write.

PATCHhttps://api.helpbento.com/v1/doc-versions/{id}/release-notes

Authentication

AuthorizationstringheaderBearer <token>required

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

Path parameters

1 param
  • idstringrequired

    The doc version id.

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
  • markdownstringrequired

    The release notes as GitHub-Flavored Markdown.

  • confirmLiveUpdateboolean

    Required (true) to update a public version's release notes, since that renders live on the public /changelog page immediately.

Responses

  • versionIdstring
  • versionStatusstringdraft | beta | stable | deprecated
  • isLiveboolean

    True when the version is public, so this change is live on the public /changelog page immediately.

  • manageUrlstring
Errors