Skip to content

Provide information about a transfer of a document to the target system

Request

Update information about the transfer for the given document

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

Id of of the document to update.

Bodyapplication/jsonrequired

Payload about the transfer

successfulbooleanrequired

Indicates if the transfer was successful or not

Example:true
messagestring

May be used to provide additional details about the transfer. Especially in the erroneous case this field is valueable.

curl -i -X POST \
  'https://api.cloud.hypatos.ai/v2/documents/{id}/transfer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "successful": true
  }'

Responses

Document transfer infor accepted

Response
No content