| code | string | |
| name | string | |
| bodyHtml | string | |
| description | 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 }}).
|
| libraryCode | string | Optional reference to the library item code this content block was imported from.
This field identifies the source template if the content block was created from the library.
Usage for API clients:
- When creating a content block, you can set this to track its library origin
- Once set during creation, this value cannot be changed
- Use this to identify which library template a content block is based on
- Combine with MatchesLibraryContents to determine if the content has been customized
Example: "engagement-letter-header" indicates this block was imported from that library template
|
Optional reference to the library item code this content block was imported from.
This field identifies the source template if the content block was created from the library.
Usage for API clients:
- When creating a content block, you can set this to track its library origin
- Once set during creation, this value cannot be changed
- Use this to identify which library template a content block is based on
- Combine with MatchesLibraryContents to determine if the content has been customized
Example: "engagement-letter-header" indicates this block was imported from that library template
|
| matchesLibraryContents | boolean | Indicates whether the current content matches the original library version.
This field is automatically computed by the system and cannot be set by clients.
Values:
- null: Not imported from library (LibraryCode is not set)
- true: Content matches the original library version exactly (no customizations)
- false: Content has been modified from the original library version
Usage for API clients:
- Use this to identify customized content blocks in your UI (e.g., show a "Modified" badge)
- Filter or warn users before overwriting modified content blocks
- Track which content blocks are still using standard library content
- Help users decide whether to sync with library updates
Example use cases:
- Show a warning: "This content block has been customized. Updating from library will overwrite your changes."
- Display visual indicators: "📝 Modified from library template" vs "✓ Using standard template"
- Filter views: "Show only customized content blocks" or "Show only standard templates"
|
Indicates whether the current content matches the original library version.
This field is automatically computed by the system and cannot be set by clients.
Values:
- null: Not imported from library (LibraryCode is not set)
- true: Content matches the original library version exactly (no customizations)
- false: Content has been modified from the original library version
Usage for API clients:
- Use this to identify customized content blocks in your UI (e.g., show a "Modified" badge)
- Filter or warn users before overwriting modified content blocks
- Track which content blocks are still using standard library content
- Help users decide whether to sync with library updates
Example use cases:
- Show a warning: "This content block has been customized. Updating from library will overwrite your changes."
- Display visual indicators: "📝 Modified from library template" vs "✓ Using standard template"
- Filter views: "Show only customized content blocks" or "Show only standard templates"
|
| 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 | |
