Skip to content

Provide an external identifier for a document with given id

Request

Provide an external identifier for a document with given id

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

Id of the document to update.

Bodytext/plainrequired

Update external id for a given document.

string(DocumentsUpdateExternalIdRequest)

External ID

curl -i -X POST \
  'https://api.cloud.hypatos.ai/v2/documents/{id}/external-id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: text/plain' \
  -d 15b884b0-d551-4865-bda9-4168800c9d87

Responses

External ID provided for the document accepted.

Response
No content