SignEnvoy docs

Error reference / bulk-not-ready

Batch is not ready for that action

Dispatch needs a ready batch; cancel needs a ready or dispatching one.

Problem type /problems/bulk-not-ready
HTTP status 409
Emitted by REST API (/v1)
Title values
Batch cannot be canceled
Batch is not ready to dispatch
Extra members status
Trigger
REST API (/v1): dispatch or cancel on a batch not in a state that allows it (D56)

What happened

POST /v1/bulk-sends/{id}/dispatch was called on a batch whose status is not ready, or POST /v1/bulk-sends/{id}/cancel on one that is already done, failed, or canceled. The response is HTTP 409 with the batch’s current status.

What it means

A batch dispatches exactly once. An invalid batch has rows to fix first; a dispatching or finished batch cannot be dispatched again; a finished batch has nothing left to cancel. Documents already sent stay sent either way.

What to do next

Read the batch with GET /v1/bulk-sends/{id}. If it is invalid, create a corrected batch; if it is dispatching, wait for done or cancel the rows still queued.

Problem body

Every error is an RFC 9457 problem document with media type application/problem+json. The type member is the stable identifier to switch on; docs_url is this page. 

{
  "type": "/problems/bulk-not-ready",
  "title": "Batch is not ready to dispatch",
  "status": "...",
  "instance": "/v1/...",
  "docs_url": "https://docs.signenvoy.com/errors/bulk-not-ready"
}