v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Update dynamic field

<small>Requires an API token with the Document Manager role.</small>

Updates the value of a dynamic field for a document.

Alternatively: if your use case involves updating multiple dynamic fields, and you have all the new values available at once, the bulk update dynamic fields request is likely to be a better fit.

Value format

The content of the value parameter depends on the type of the dynamic field. The table below lists the available types and shows how values of each type should be sent.

Descriptive name	API type	Example values	Description
Email	email	"user@example.com"	An email address.
Number	number	1234.56	A numeric value.
Currency	currency	"EUR;1234.56", "EUR;1234"	A string containing a currency code and numeric value concatenated with a semicolon.
Currency over time	currency_duration	"EUR;1234.56;monthly", "EUR;123456;yearly"	A string containing a currency code, numeric value and period (one of monthly or yearly) concatenated with a semicolon.
Select	select	"Blue"	One of the values from the field's select_values list.
Multi-select	multi_select	["Red","Blue"]	Array containing one or more values from the field's select_values list.
Date	date	"2025-12-31"	A date in the format "YYYY-MM-DD".
Yes / No	bool	true, false	A boolean value.
Duration	duration	"P6D" (6 days), "P2W" (2 weeks), "PT12H" (12 hours)	A string containing a duration specification.
Text	text	"Vienna"	Up to 4096 characters of text.
Multi-line text	textarea	"Another text value"	Up to 4096 characters of text.

put/documents/{document}/dynamic-fields/{dynamicField}

Path parameters

documentstring required

The document UUID

dynamicFieldstring required

The dynamic field UUID

Request body

Response

DynamicFieldResource

Example response

{
  "data": {
    "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
    "ref_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Gross salary",
    "settings": {
      "currencies": [
        "EUR",
        "USD"
      ]
    },
    "format": {
      "decimals": 2,
      "decimal_separator": ".",
      "thousands_separator": ","
    },
    "question": "What is the employee's gross salary in EUR?"
  }
}