CustomTokenDto
A user-defined custom token for document templates
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this custom token |
The unique code for this custom token | ||
| name | string | Human-readable display name for the token (e.g. "Company Secretary") |
Human-readable display name for the token (e.g. "Company Secretary") | ||
| tokenIdentifier | string | The token identifier used in templates (e.g. "CompanySecretary" for {{ Custom.CompanySecretary }}). |
The token identifier used in templates (e.g. "CompanySecretary" for {{ Custom.CompanySecretary }}). | ||
| description | string | Optional prompt text shown when filling in the token value |
Optional prompt text shown when filling in the token value | ||
| defaultValue | string | Optional default value pre-populated in the token form |
Optional default value pre-populated in the token form | ||
| displayWidth | string | Preset display width for the input. Null defaults to Full. |
Preset display width for the input. Null defaults to Full. | ||
| lines | integer | Number of visible text lines. Null renders a single-line input, 2+ renders a textarea. |
Number of visible text lines. Null renders a single-line input, 2+ renders a textarea. | ||
| isRichText | boolean | When true and Lines >= 2, the input renders as a rich text editor instead of a plain textarea. |
When true and Lines >= 2, the input renders as a rich text editor instead of a plain textarea. | ||
| createdDate | string | When the token was created |
When the token was created | ||
| updatedDate | string | When the token was last updated |
When the token was last updated | ||
JSON Example
{
"code": "string",
"name": "string",
"tokenIdentifier": "string",
"description": "string",
"defaultValue": "string"
}