Cancel Ingestion

POST

https://api.firmeasy.legal/api/v1/documents/envelopes/{{ingest_token}}/cancel

Cancel Ingestion

Cancels and marks as cancelled a batch ingestion process that is still in progress (ingesting or assembling). If the envelope has already reached a terminal state, the operation will be rejected.

Authentication

Parameter	Type	Description	Limits
`Authorization`	string	Bearer authentication token.	Required (Bearer <token>)

Authorization

string

Bearer authentication token.

Limits:Required (Bearer <token>)

Path Parameters

Parameter	Type	Description	Limits
`ingest_token`	string (UUID)	The identifier token of the ingestion batch to cancel.	Required

ingest_token

string (UUID)

The identifier token of the ingestion batch to cancel.

Limits:Required

Successful Response (200 OK)

The request was processed successfully and the batch status has changed to cancelled immediately. It returns no response body (empty body).

Common Error Responses

Código	Estado	Descripción
`401`	Unauthorized	The authentication token is invalid, expired, or was not sent.
`404`	Not Found	The provided `ingest_token` does not exist or does not belong to the active organization.
`409`	Conflict	The ingestion batch is already in a terminal state (`ready`, `failed`, or `cancelled`) and cannot be aborted.