POST
Add a catalogue template
Company space For: Administrator, Manager · Permission: company_templates.create Conditions
  • Company-owned templates cannot be obtained this way.
  • The template must be listed and have a published version.
  • The company must not already own the template; a copy that was deleted does not count as owned and is restored instead.
What else happens
  • Creates a company template pinned to the template’s current version, inactive and with empty settings. No payment is taken.
  • When the company had a deleted copy, it is restored, re-pinned to the current version, made inactive, its purchase date is reset and settings no longer in the schema are removed.
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

template
string
required

Identifier of the template in the catalogue (27-character KSUID string).

Body

application/json
name
string | null

Name given to the company's copy, at most 255 characters. Defaults to the catalogue template's name. Ignored when a deleted copy is restored.

Maximum string length: 255

Response

CompanyTemplateResource

data
CompanyTemplateResource · object
required

Items of this page.