Skip to content

Acknowledges one exact Delivery with CAS and idempotent receipt semantics.

POST
/v1/m/sessions/deliveries/{id}/ack
curl --request POST \
--url https://example.com/v1/m/sessions/deliveries/example/ack \
--header 'Authorization: Bearer <token>' \
--header 'Idempotency-Key: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'If-Match: example'

Acknowledges one exact Delivery with CAS and idempotent receipt semantics.

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

If-Match
required
string
/^\"v[0-9]+\"$/

Current strong Delivery ETag.

Idempotency-Key
required
string format: uuid

Canonical UUID binding the exact Ack command.

Ack committed or replayed

Media type application/json
object
ack_id
required
string format: uuid
audit_seq
required
integer format: int64
command_id
required
string format: uuid
delivery_id
required
string format: uuid
etag
required
string
event_id
required
string format: uuid
fulfillment
required
object
acknowledged
required
integer format: int64
quorum
integer format: int64
required
required
integer format: int64
state
required
string
unmet
required
integer format: int64
viable
required
integer format: int64
late
required
boolean
message_id
required
string format: uuid
replayed
required
boolean
state
required
string
version
required
integer format: int64
Example generated
{
"ack_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"audit_seq": 1,
"command_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"delivery_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"etag": "example",
"event_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"fulfillment": {
"acknowledged": 1,
"quorum": 1,
"required": 1,
"state": "example",
"unmet": 1,
"viable": 1
},
"late": true,
"message_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"replayed": true,
"state": "example",
"version": 1
}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict

Media type application/json
object
Example generated
{}

Precondition failed

Media type application/json
object
Example generated
{}

Required precondition missing

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}

Current authority, custody or store evidence is unavailable; or, with code commit_outcome_unknown, the write was issued and its outcome was never learned, so it may be durable and must not be retried automatically

Media type application/json
object
Example generated
{}