ContentBlockDto

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

Properties

Name	Type	Description
code	string	Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
libraryCode	string	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".
libraryStatus	enum	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
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
deprecated	boolean	True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
bodyHtml	string
category	enum	Custom ServiceTerms ServiceProposals TemplateParts WebContent Email EmailParts
Custom ServiceTerms ServiceProposals TemplateParts WebContent Email EmailParts
subjectLine	string	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 }}).
hasClientTokens	boolean	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.
createdDate	string
updatedDate	string

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas

ContentBlockDtoPagedResult