Skip to main content
POST
Run a retained message's routing decision again

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key; a retry with the same key and body replays the first answer.

Path Parameters

messageId
string<uuid>
required

The message's surrogate id, from the listing.

Body

application/json
reason
string
required

Why the decision should be run again. 1 to 512 characters after trimming, with no NUL.

Response

Accepted

channelId
enum<string>
required
Available options:
spb,
pix
messageId
string<uuid>
required
receivedAt
string<date-time>
required
reevaluatedAt
string<date-time> | null
required

The last time the rail tried its routing decision again and the message stayed retained, whether the decision ran or failed; null when it never tried.

releasable
boolean
required

True when the cause is routing or delivery: no owner in the map, a map that could not answer, an owner disabled or unreachable, no delivery mode declared for its code. Only these are re-checked by themselves once the cause lifts, and only these can be re-evaluated; a Pix retention also clears when the vendor resends it. An UNRECOGNIZED_TYPE of a non-financial code releases once a delivery mode is declared for its code and is not re-checked before that; one of a financial code releases on the re-check after a Courier release reads its destination.

retainedAt
string<date-time>
required
retentionReason
string
required
reevaluation
object

The last operator request to re-evaluate it; null when nobody asked.

unassignedKey
object

ACCOUNT_UNASSIGNED only: the key the Courier looked up in the ownership map and found no owner for. Assign it (POST /v1/ownership/assignments) and the message is released on its next re-check: for ACCOUNT, send the text before ':' as branch (empty means a payment account) and the text after it as account; any other kind takes keyValue as shown. A raw key (one the map cannot hold) cannot be assigned; it needs a person. Null for every other reason, and for a Pix leg that waits on an earlier leg of its payment, which no key routes.