API Docs / Schemas / UpdateCustomTokenRequest

UpdateCustomTokenRequest

DTO for updating a custom token

Properties

Name Type Description
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 }}).
Must be alphanumeric with underscores only. Unique per tenant.

The token identifier used in templates (e.g. "CompanySecretary" for {{ Custom.CompanySecretary }}).
Must be alphanumeric with underscores only. Unique per tenant.

descriptionstring

Optional prompt text shown when filling in the token value

Optional prompt text shown when filling in the token value

defaultValuestring

Optional default value pre-populated in the token form

Optional default value pre-populated in the token form

displayWidthstring

Preset display width for the input. Null defaults to Full.

Preset display width for the input. Null defaults to Full.

linesinteger

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.

isRichTextboolean

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.

JSON Example

{
  "name": "string",
  "tokenIdentifier": "string",
  "description": "string",
  "defaultValue": "string",
  "displayWidth": "string"
}

Used By Operations