Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Document Operations

Bulk update dynamic fields

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

Updates the value of one or more dynamic fields for a document.

The values parameter should be an object with up to 20 entries whose keys identify the document's dynamic fields and whose values are the new values to set. Valid identifiers to use as keys are a dynamic field's uuid, ref_uuid or name. Values should follow the same rules as described for the update dynamic field request.

Returns the dynamic fields that were changed by the request.

put/documents/{document}/dynamic-fields

Path parameters

documentstring required

The document UUID

Request body

valuesobject required

New values for up to 20 of the document's dynamic fields. Each key must identify a dynamic field on the document - by either its ref_uuid, uuid or name. Values expect the same format as the Update dynamic field endpoint.

Example request

{
  "values": {
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890": "EUR;95000;yearly",
    "My Text Field": "Vienna"
  }
}

Response

Array of 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?"
    }
  ]
}