Skip to main content
PUT
Declare the delivery mode for one message code

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

channelId
enum<string>
required

The rail. Closed vocabulary — a value outside it is a 404, never a new rail.

Available options:
spb,
pix
messageCode
string
required

The vendor's own message code, verbatim.

Body

application/json
mode
enum<string>
required
Available options:
ALL_ENGINES,
REFUSE
reason
string
required
Required string length: 1 - 512

Response

OK

channelId
enum<string>
required
Available options:
spb,
pix
declaredAt
string<date-time>
required
declaredBy
string
required
Maximum string length: 128
messageCode
string
required
Pattern: ^[A-Za-z0-9_.-]{1,32}$
mode
enum<string>
required
Available options:
ALL_ENGINES,
REFUSE
reason
string
required
Maximum string length: 512
ruleId
string<uuid>
required
revokedAt
string<date-time> | null

Non-null means this row is history.

revokedBy
string | null
Maximum string length: 128