Get send progress for a contract batch

Progress for one batch of contracts: total_count / sent_count / failed_count, every envelope in the batch, and a failures list naming the creators whose delivery failed and why. Poll this after a batch is sent from the portal to watch it drain.

404 when the batch does not belong to this shop. Single-shop only.

get/contracts/batches/{batch_id}

Path parameters

batch_idstring uuid required

Batch id (UUID).

Response

Successful Response

batch_idstring uuid required

status'queued' | 'sending' | 'completed' | 'partial_failure' | 'failed' required

total_countinteger required

sent_countinteger required

failed_countinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.