Account

Update metadata

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

PUT

/metadata/{metadata}

Update metadata

curl --request PUT \
  --url https://app.fynk.com/v1/api/metadata/{metadata} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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",
  "prompt": "Extract the discount rate percentage from the document.",
  "relevant_document_type_uuids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "select_values": [
    "<string>"
  ]
}
'

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

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

metadatastringrequired

The metadata UUID

Body

descriptionstring | null

A description of the metadata field.

Maximum string length: 1024

Example: The discount rate applied to the company valuation in a follow-on financing round.

display_namestring

The display name shown in the UI.

Maximum string length: 255

Example: Discount Rate

is_contract_valueboolean | null

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

keywordsstring | null

Keywords to help with metadata identification.

Maximum string length: 1024

Example: discount, rate, valuation

promptstring | null

An AI prompt used for metadata extraction.

Maximum string length: 1024

Example: Extract the discount rate percentage from the document.

relevant_document_type_uuidsstring[] | null

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.

select_valuesstring[] | null

The possible values when value_type is select or multi_select.

Response

MetadataResource

dataobjectrequired

Show child attributes

Still need help? Share an idea