Skip to main content
POST
/
documents
/
{document_id}
/
cancel
Cancel Document
curl --request POST \
  --url http://localhost:8000/documents/{document_id}/cancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "cancellation_requested_at": "2023-11-07T05:31:56Z"
}

Headers

authorization
string | null
x-api-key
string | null
x-tenant-id
string | null

Path Parameters

document_id
string<uuid>
required

Cookies

factio_access_token
string | null

Body

application/json
reason
string
required
Required string length: 1 - 500

Response

Successful Response

document_id
string<uuid>
required
status
string
required
cancellation_requested_at
string<date-time>
required