Skip to content

Provide external data for a document with given id

Request

Update the external data for a document with given identifier. The external data are provided as a flat JSON object. The payload of this requests completley overrides the existing external data of a document. To remove the data, justsend empty JSON object {} in the payload.

Please note that the maximum lenght of an key is 50 characters. Any value with a longer key will be omitted. The maximum amount of key-value pairs is limited to 20.

Security
OAuth2(Required scopes: documents.write)
Path
idstringrequired

Id of the document to update.

Bodyapplication/jsonrequired

Payload containing the external data.

key1string
Example:"value1"
key2string
Example:"value2"
curl -i -X POST \
  'https://api.cloud.hypatos.ai/v2/documents/{id}/external-data' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key1": "value1",
    "key2": "value2"
  }'

Responses

External data provided for the document accepted.

Response
No content