v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Bulk update metadata values

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

Sets or removes the values of one or more metadata fields for a document in a single request.

The changes parameter is a list of up to 20 objects, each identifying a metadata by its uuid or name, and specifying an operation:

set: adds the metadata to the document (if not already present) and sets its value. The value follows the same format as the Add metadata value to document endpoint.
unset: removes the document's value for the metadata, equivalent to the Delete metadata value endpoint.

Returns the metadata values that were set; metadata values that were unset are not included in the response.

put/documents/{document}/metadata-values

Path parameters

documentstring required

The document UUID

Request body

Example request

{
  "changes": [
    {
      "identifier": "purchase_price",
      "value": "EUR;1000.10"
    }
  ]
}

Response

Array of MetadataValueResource

Example response

{
  "data": [
    {
      "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
      "metadata": {
        "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
        "name": "discount_rate",
        "display_name": "Discount Rate",
        "settings": {
          "currencies": [
            "EUR",
            "USD"
          ]
        },
        "description": "The discount rate applied to the company valuation in a follow-on financing round.",
        "keywords": "discount, rate, valuation",
        "prompt": "Extract the discount rate percentage from the document."
      },
      "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc"
    }
  ]
}