Ir al contenido
FirmEasy

Cancelar ingesta

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

Cancela y marca como cancelled un proceso de ingesta por lotes que todavía se encuentre en curso (ingesting o assembling). Si el sobre ya alcanzó un estado terminal, la operación será rechazada.


Authorization
string
Token de autenticación Bearer.
Límites:Obligatorio (Bearer <token>)

ingest_token
string (UUID)
El token identificador del lote de ingesta que se desea cancelar.
Límites:Obligatorio

La solicitud fue procesada correctamente y el estado del lote ha cambiado a cancelado de manera inmediata. No devuelve cuerpo de respuesta (cuerpo vacío).


Código Estado Descripción
401 Unauthorized El token de autenticación es inválido, expiró o no fue enviado.
404 Not Found El ingest_token provisto no existe o no corresponde a la organización activa.
409 Conflict El lote de ingesta ya se encuentra en un estado terminal (ready, failed o cancelled) y no puede ser abortado.