POST
Switch template version
Company space For: Administrator, Manager · Permission: company_templates.upgrade Conditions
  • The version must belong to the same template, otherwise the call is refused. An older version is accepted, which makes this action the rollback path.
What else happens
  • Pins the company template to the target version; when template_version_id is omitted, the template’s current version is used.
  • Settings whose keys are not in the target version’s configuration schema are removed and returned in dropped_settings.
Part of Invoice and document templates.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

companyTemplate
string
required

Identifier of the company template, the company's own copy of a template (27-character KSUID string).

Body

application/json
template_version_id
string | null

Identifier of the version to move to; it must belong to the same template and can be older than the current pin. When omitted, the template's current version is used.

Maximum string length: 27

Response

JsonResource

data
string
required

Items of this page.