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

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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

Parâmetros de caminho

channelId
enum<string>
obrigatório

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

Opções disponíveis:
spb,
pix
messageCode
string
obrigatório

The vendor's own message code, verbatim.

Corpo

application/json
mode
enum<string>
obrigatório
Opções disponíveis:
ALL_ENGINES,
REFUSE
reason
string
obrigatório
Required string length: 1 - 512

Resposta

OK

channelId
enum<string>
obrigatório
Opções disponíveis:
spb,
pix
declaredAt
string<date-time>
obrigatório
declaredBy
string
obrigatório
Maximum string length: 128
messageCode
string
obrigatório
Pattern: ^[A-Za-z0-9_.-]{1,32}$
mode
enum<string>
obrigatório
Opções disponíveis:
ALL_ENGINES,
REFUSE
reason
string
obrigatório
Maximum string length: 512
ruleId
string<uuid>
obrigatório
revokedAt
string<date-time> | null

Non-null means this row is history.

revokedBy
string | null
Maximum string length: 128