API Docs / Schemas / CreateContentBlockRequest

CreateContentBlockRequest

Request to create a new reusable content block that can be included in document templates.
Content blocks are shared sections of content that maintain consistency across documents.

Properties

Name Type Description
name*string

Display name for the content block (e.g., "Standard Header", "Legal Footer", "Signature Block")

Display name for the content block (e.g., "Standard Header", "Legal Footer", "Signature Block")

bodyHtmlstring

HTML content of the block with Liquid syntax support.
Content blocks receive the same token context as the parent template, allowing them to access:

  • All data passed to the template (client, services, custom fields)
  • System-provided tokens (tenant, date)
  • Nested content blocks using {{ contentBlock "another-block" }}

Example header block:

{{ tenant.name }}

{{ tenant.address.line1 }}, {{ tenant.address.city }}

Date: {{ date | date: "%B %d, %Y" }}

Example conditional footer:

{% if client.isVatRegistered %}

VAT Number: {{ client.vatNumber }}

{% endif %}

© {{ date | date: "%Y" }} {{ tenant.name }}

HTML content of the block with Liquid syntax support.
Content blocks receive the same token context as the parent template, allowing them to access:

  • All data passed to the template (client, services, custom fields)
  • System-provided tokens (tenant, date)
  • Nested content blocks using {{ contentBlock "another-block" }}

Example header block:

{{ tenant.name }}

{{ tenant.address.line1 }}, {{ tenant.address.city }}

Date: {{ date | date: "%B %d, %Y" }}

Example conditional footer:

{% if client.isVatRegistered %}

VAT Number: {{ client.vatNumber }}

{% endif %}

© {{ date | date: "%Y" }} {{ tenant.name }}

descriptionstring

Optional description explaining the block's purpose and where it should be used

Optional description explaining the block's purpose and where it should be used

category*enum

Custom ServiceTerms ServiceProposals TemplateParts WebContent Email EmailParts

Custom ServiceTerms ServiceProposals TemplateParts WebContent Email EmailParts

subjectLinestring

Optional subject line for email content blocks (only relevant when Category is EmailParts).
Supports merge field syntax (e.g., {{ Client.Name }}).

Optional subject line for email content blocks (only relevant when Category is EmailParts).
Supports merge field syntax (e.g., {{ Client.Name }}).

libraryCodestring

Optional reference to the library item code this content block was imported from.
Used to track the origin of content blocks created from the library.
Can only be set during creation and cannot be modified later.

Optional reference to the library item code this content block was imported from.
Used to track the origin of content blocks created from the library.
Can only be set during creation and cannot be modified later.

JSON Example

{
  "name": "string",
  "bodyHtml": "string",
  "description": "string",
  "category": "Custom",
  "subjectLine": "string"
}

Used By Operations