Document Operations

Add metadata value to document

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

POST

/documents/{document}/metadata-values

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/{document}/metadata-values \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
  "value": "EUR;95000;yearly"
}
'

{
  "data": {
    "computed_at": "2023-11-07T05:31:56Z",
    "computed_status": "missing_information",
    "computed_value": "EUR;95000;yearly",
    "is_attached": true,
    "metadata": {
      "always_exists": true,
      "description": "The discount rate applied to the company valuation in a follow-on financing round.",
      "display_name": "Discount Rate",
      "is_contract_value": true,
      "keywords": "discount, rate, valuation",
      "name": "discount_rate",
      "prompt": "Extract the discount rate percentage from the document.",
      "relevant_document_type_uuids": [
        "<string>"
      ],
      "select_values": [
        "<string>"
      ],
      "settings": {
        "currencies": [
          "EUR",
          "USD"
        ]
      },
      "type": "system_autofilled",
      "uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
      "value_type": "id"
    },
    "reference_dynamic_field_uuid": "7dae3dad-e56d-45e9-86e5-b69dc30597dc",
    "uuid": "4ed6c60b-bc4f-4390-bbf5-ed384e3443c9",
    "value": "EUR;95000;yearly",
    "value_currency_monthly": "<string>",
    "value_currency_yearly": "<string>",
    "value_source": "user"
  }
}

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.