Skip to content

Acknowledge a processed message

Last updated 

POST /spools/{spool}/ack

Completes the delivery: the message is durably removed from its queue. The lease names the queue, so the op is spool-scoped — a wrong queue is unrepresentable.

Sample

sh
curl -X POST "$SPOOLER_API/spools/<spool>/ack" \
  -H "Authorization: Bearer $SPOOLER_KEY" \
  -H "Content-Type: application/json" \
  --data '{"lease": "<lease>"}'

Parameters

NameInTypeRequiredDescription
spoolpathIdentName, 1–64 chars, ^[A-Za-z0-9_:-]+$yesThe spool name.

Request body

Required; application/json.

FieldTypeRequiredDescription
leaseLeaseToken, 16–128 chars, ^[A-Za-z0-9_-]+$yesOpaque signed lease token (base64url) from a receive or from failures/head. Scoped to the operations of its source: a receive lease settles (ack/nack/renew), a failure lease recovers or discards — never interchangeable. Never inspect or construct one.

Responses

StatusDescription
204Acknowledged.
400The request is malformed; the kind names the problem.
401The API key is missing or not recognized.
402The account is suspended.
403A plan limit refuses the operation; the kind names it.
404The spool or queue does not exist; the kind says which.
409Concurrent state refuses the operation; the kind names it.
410The lease no longer settles anything: expired, already settled, or predates a primary change.
429The per-account request rate cap is exceeded; retry after the Retry-After delay.
500The server failed; kind operation_unconfirmed means the write was accepted but its durability is unknown.
503The spool is momentarily unavailable.

429 headers

HeaderDescription
Retry-AfterSeconds until the next request is admitted.