Sign in

v1

latestOpenAPI 3.1.02026-08-066378446.6 KB
Document Operations

Update metadata value

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

Updates the value of a metadata field for a document.

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

Value format

The content of the value parameter must follow the same rules as described in the Add metadata value to document documentation.

put/documents/{document}/metadata-values/{metadataValue}

Path parameters

documentstring required

The document UUID

metadataValuestring required

The metadata value UUID

Request body

Response

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"
  }
}