Update document dynamic fields
update-document-dynamic-fieldsUpdate the value of one or more of a document's dynamic fields.
Use this tool when:
You want to fill in (or change) values for fields like text inputs, dates, numbers, or selects on a document
A user asks to set values that signing requires before it can begin (mandatory dynamic fields)
Each entry in dynamic_field_values identifies the field by its ref_uuid or name (use get-document-info with include=["dynamic_fields"] to discover them) — sending the wrong key will fail validation.
Take note of the field's type when constructing the value. These are the rules to use when constructing the value string:
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" (for one thousand Euro and ten cents)
currency_duration: same as currency, but append another ';' followed by either
monthlyoryearly-> "EUR;1000.10;monthly" / "USD;1000.10;yearly"select: one of the options from the field's
select_valueslist -> "red"multi_select: an array of the selected values in the
valuesfield -> ["red", "blue"]bool: either of the strings "true" (displayed to the user as "Yes") or "false" (displayed to the user as "No") -> "true" / "false"
duration: a PHP-compatible duration specification -> "P6D" (6 days), "P2W" (2 weeks), "PT12H" (12 hours)
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"
To unset a dynamic field, send a null value.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_uuid | Yes | UUID of the document whose dynamic fields are to be updated. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| dynamic_field_values | No | New values to apply (at most 10 per request). Signing can only start when all mandatory dynamic fields have values provided. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dynamic_fields | No | The fields that were updated |