v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Account

Update metadata

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

Updates an account-level metadata field definition.

Only account-level metadata fields can be updated; system metadata is read-only.

Note that while a metadata's name and value_type cannot be changed, the display_name may be updated via this request.

Returns a 409 Conflict if a bulk metadata management operation is currently in progress for this metadata field.

put/metadata/{metadata}

Path parameters

metadatastring required

The metadata UUID

Request body

display_namestring

The display name shown in the UI.

descriptionstring nullable

A description of the metadata field.

promptstring nullable

An AI prompt used for metadata extraction.

keywordsstring nullable

Keywords to help with metadata identification.

is_contract_valueboolean nullable

Whether this is a contract value field. Can only be true when value_type is currency or currency_duration.

select_valuesstring[] nullable

The possible values when value_type is select or multi_select.

relevant_document_type_uuidsstring[] nullable

UUIDs of document types this metadata is relevant for. null means not relevant to any document types. [] (empty array) means relevant to all document types.

Example request

{
  "display_name": "Discount Rate",
  "description": "The discount rate applied to the company valuation in a follow-on financing round.",
  "prompt": "Extract the discount rate percentage from the document.",
  "keywords": "discount, rate, valuation"
}

Response

MetadataResource

Example response

{
  "data": {
    "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."
  }
}