v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

Add metadata value to document

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

Adds a metadata field to a document and optionally sets its value.

Alternatively: if your use case involves setting values for 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 depends on the value_type of the metadata. 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	"Dublin"	Up to 4096 characters of text.
Timestamp	timestamp	"2025-06-02T14:30:00+00:00"	A date/time value.
Clause	clause	true, false	Indicates presence of a particular clause in the document.

post/documents/{document}/metadata-values

Path parameters

documentstring required

The document UUID

Request body

metadata_uuidstring

UUID of the metadata to add a value for

Example request

{
  "metadata_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc"
}

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