API Docs / Schemas / ContentBlockDto

ContentBlockDto

DTO for content blocks, exposing only codes and structured data (never DB IDs).

Properties

Name Type Description
libraryCodestring

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

The Code of the library template this entity was imported from, or null if the entity
is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".

libraryStatusenum

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

Describes a library-imported entity's relationship to its source library template.

NotFromLibrary UpToDate LocallyModified LibraryUpdated

isImportedboolean

True if the tenant has already imported this library item.

True if the tenant has already imported this library item.

codestring
namestring
bodyHtmlstring
descriptionstring
categoryenum

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 }}).

hasClientTokensboolean

Whether any field (SubjectLine or BodyHtml) contains {{ Client.* }} Liquid tokens.
Use to determine if a content block requires a client context for rendering.

Whether any field (SubjectLine or BodyHtml) contains {{ Client.* }} Liquid tokens.
Use to determine if a content block requires a client context for rendering.

createdDatestring
updatedDatestring

JSON Example

{
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary",
  "isImported": false,
  "code": "string",
  "name": "string"
}

Used By Operations

Contained in Schemas