Update template dynamic field
update-template-dynamic-fieldUpdate an existing dynamic field on a template.
Use this tool when:
The user wants to change a dynamic field's name, scope, options, default value, or other properties
Only send the fields you want to change. A field's type cannot be changed after creation; to change the type,
delete the field and create a new one.
select and multi_select fields still require non-empty select_values.
The default value is set via value (for non-multi_select fields) or values (for multi_select fields), formatted
according to the field's type (see create-template-dynamic-field for the per-type format). Setting a default value
clears any autofill configured on the field. Use get-template-info with include=["dynamic_fields"] to discover the
dynamic fields on a template and their UUIDs and types.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"template_uuid": "<template_uuid>",
"dynamic_field_uuid": "<dynamic_field_uuid>"
},
"name": "update-template-dynamic-field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Display name of the field (max 255 characters) | |
| scope | No | Who fills in the field: "internal" (only your team) or "internal_and_external" (also counterparties) | |
| value | No | Default value for non-multi_select fields. Format depends on type (see create-template-dynamic-field). Clears any autofill on the field. | |
| values | No | 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 | |
| select_values | No | For "select" and "multi_select" types: the allowed options for the field | |
| template_uuid | Yes | UUID of the template the dynamic field belongs to | |
| dynamic_field_uuid | Yes | UUID of the dynamic field to update (use get-template-info with include=["dynamic_fields"] to find it) |
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 |