API Docs / Schemas / CreateDocumentTemplateRequest

CreateDocumentTemplateRequest

Request to create a new document template that can generate documents using Liquid syntax.
Templates support tokens for dynamic data replacement and can include reusable content blocks.

Properties

Name Type Description
name*string

Display name for the template (e.g., "Standard Engagement Letter", "Monthly Report")

Display name for the template (e.g., "Standard Engagement Letter", "Monthly Report")

type*enum

EngagementLetter Proposal ProfessionalClearanceLetter

EngagementLetter Proposal ProfessionalClearanceLetter

bodyHtml*string

Template body in HTML with Liquid syntax tokens.
Supported tokens:

  • {{ client.name }} - Client's name
  • {{ client.companyNumber }} - Company registration number
  • {{ tenant.name }} - Your practice name
  • {{ date | date: "%B %d, %Y" }} - Current date (formatted)
  • {{ contentBlock "block-code" }} - Include a reusable content block
  • {% if client.isVatRegistered %} ... {% endif %} - Conditional content
  • {% for item in services %} ... {% endfor %} - Loop through collections
    Custom tokens can be passed via the Data parameter when rendering.

Template body in HTML with Liquid syntax tokens.
Supported tokens:

  • {{ client.name }} - Client's name
  • {{ client.companyNumber }} - Company registration number
  • {{ tenant.name }} - Your practice name
  • {{ date | date: "%B %d, %Y" }} - Current date (formatted)
  • {{ contentBlock "block-code" }} - Include a reusable content block
  • {% if client.isVatRegistered %} ... {% endif %} - Conditional content
  • {% for item in services %} ... {% endfor %} - Loop through collections
    Custom tokens can be passed via the Data parameter when rendering.
descriptionstring

Optional description explaining the template's purpose and usage

Optional description explaining the template's purpose and usage

isActiveboolean

Whether this template is available for use. Set to false to disable without deleting.

Whether this template is available for use. Set to false to disable without deleting.

defaultDesignThemeCodestring

Code of the default design theme to apply when rendering this template.
If not specified, falls back to the tenant's default theme.

Code of the default design theme to apply when rendering this template.
If not specified, falls back to the tenant's default theme.

JSON Example

{
  "name": "string",
  "type": "EngagementLetter",
  "bodyHtml": "string",
  "description": "string",
  "isActive": false
}

Used By Operations