API Docs / Schemas / DocumentTemplateTokenInfo

DocumentTemplateTokenInfo

Information about a token found in a document template,
including metadata from custom token definitions when available.

Properties

Name Type Description
namestring

The token key used for form values (e.g. "Title", "Custom.InvoiceRef")

The token key used for form values (e.g. "Title", "Custom.InvoiceRef")

labelstring

Human-readable display label for the token (e.g. "Invoice Ref").
Falls back to Name if not set.

Human-readable display label for the token (e.g. "Invoice Ref").
Falls back to Name if not set.

descriptionstring

Optional description/prompt text for the token (from custom token definition)

Optional description/prompt text for the token (from custom token definition)

defaultValuestring

Optional default value for the token (from custom token definition)

Optional default value for the token (from custom token definition)

isCustomTokenboolean

Whether this token is a user-defined custom token (Custom.* prefix)

Whether this token is a user-defined custom token (Custom.* prefix)

displayWidthstring

Preset display width for the input (from custom token definition). Null defaults to Full.

Preset display width for the input (from custom token definition). Null defaults to Full.

linesinteger

Number of visible text lines (from custom token definition). Null renders a single-line input.

Number of visible text lines (from custom token definition). Null renders a single-line input.

isRichTextboolean

When true, the input renders as a rich text editor. The value will contain HTML.

When true, the input renders as a rich text editor. The value will contain HTML.

JSON Example

{
  "name": "string",
  "label": "string",
  "description": "string",
  "defaultValue": "string",
  "isCustomToken": false
}