Create template dynamic field
create-template-dynamic-fieldCreate a new dynamic field on a template.
Use this tool when:
The user wants to add a variable / fill-in field (e.g. text, number, date, select) to a template
You are building up a template and need a placeholder whose value is filled in per document
IMPORTANT: this is only the first of two steps. Creating the field does NOT place it in the template content, so on
its own the fill-in placeholder will not appear in the document text. To make it show up, reference the returned
ref_uuid in the template body (via replace-template-content) as:
<span data-dynamic-field data-ref-uuid="<dynamic field ref_uuid>"></span>Until it is referenced in the content the field exists but is rendered nowhere. The same two-step pattern applies
to signature blocks (create-template-signature-block, then
<div data-signatures><span data-signature-block data-ref-uuid="..."></span></div>).
Dynamic fields define the variable data filled in when a template is used to create a document. Each field has a
type controlling what values it accepts, and a scope controlling who fills it in.
A party's name or address is never a dynamic field. Both live on the party record: add the party with create-template-party and render its details in the content with , taking data-format="address" for the address as a block and data-format="address:inline" for it on one line, as a preamble reads it. A document made from the template then follows its own parties.
select and multi_select fields require select_values (the allowed options).
The optional default value is set via value (for non-multi_select fields) or values (for multi_select fields).
Construct the value string according to the field type:
number: the numeric value in a string, using '.' as the decimal separator -> "1234.56"
currency: concatenate the ISO currency code and the numeric value with a ';' -> "EUR;1000.10"
currency_duration: same as currency, but append another ';' followed by either
monthlyoryearly-> "EUR;1000.10;monthly"select: one of the options from
select_values-> "red"multi_select: an array of the selected options in the
valuesfield -> ["red", "blue"]bool: either of the strings "true" (shown as "Yes") or "false" (shown as "No")
duration: a PHP-compatible duration specification -> "P6D" (6 days)
date: the date in the format "YYYY-MM-DD" -> "2026-12-31"
email, text, textarea, or any type not listed above: a string -> "test@example.com"
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name of the field (max 255 characters) | |
| type | Yes | Controls the type of values the field accepts (e.g. "text", "number", "date", "select") | |
| scope | No | Who fills in the field: "internal" (only your team) or "internal_and_external" (also counterparties). Defaults to "internal_and_external". | |
| value | No | Optional default value for non-multi_select fields. Format depends on type (see tool description). | |
| values | No | Optional default value for multi_select fields: an array of options from select_values | |
| question | No | Optional question or prompt shown to the user filling in this field | |
| is_mandatory | No | Whether the field must be filled in before the document can be signed. Defaults to false. | |
| select_values | No | Required for "select" and "multi_select" types: the allowed options for the field | |
| template_uuid | Yes | UUID of the template to add the dynamic field to |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the field | |
| type | No | Controls the type of values that can be stored | |
| uuid | No | Do not show to the user unless they ask for it | |
| scope | No | Who fills in the field: "internal" (only your team) or "internal_and_external" (also counterparties) | |
| value | No | For none-multi_select-type fields, the value of the field. Absent when the field has no value. | |
| values | No | For multi_select-type fields, the value of the field. Absent when the field has no value. | |
| question | No | The question or prompt shown to the user for this field | |
| ref_uuid | No | A static reference identifier, allowing dynamic fields in documents to be matched their corresponding field in the document's source template. Do not show to the user unless they ask for it | |
| currencies | No | For currency or currency_duration fields, the allowed currency codes (e.g. ["EUR", "USD"]). Absent indicates no restriction | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| is_mandatory | No | Whether this field must be filled in before the document can be signed | |
| select_values | No | When type is "select" or "multi_select", defines the allowed values for the field. For these types of field, ONLY these values are possible. Absent for every other type |