PUT
Customize a template's settings
Company space For: Administrator, Manager · Permission: company_templates.update Conditions
  • settings must be an object. Every key must exist in the configuration schema of the pinned version and each value must match the declared type.
  • The settings payload may not exceed 64 KB.
What else happens
  • Replaces the whole settings map; keys left out go back to the defaults of the configuration schema.
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

Structural validation only — key/type validation against the pinned version's config schema happens in CompanyTemplateSettingsService (D6), where the schema is loaded once with the instance.

settings
object
required

The complete set of customization values, as an object keyed by setting name. Replaces the existing settings. Each key must exist in the pinned version's configuration schema and the value must match its type (string, text, boolean, integer or number). At most 64 KB. Required.

Response

CompanyTemplateResource

data
CompanyTemplateResource · object
required

Items of this page.