Skip to main content
POST
Ask to close a deadline-expired message as failed

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Idempotency key. Required on every mutation.

Corpo

application/json
operationRef
string
obrigatório

Row key exactly as the listing returned it in correlation.operationRef (the NUOp of a deadline-expired message).

Minimum string length: 1
reason
string
obrigatório

Operator justification, persisted on the case.

Required string length: 1 - 512
verb
enum<string>
obrigatório

Operator intent; must be offered on the row.

Opções disponíveis:
MANUAL_RESOLUTION
Exemplo:

"MANUAL_RESOLUTION"

outcome
enum<string>

What the parked answer reports: SETTLED applies the leg's settled outcome and emits its settlement fact; FAILED closes the leg as failed.

Opções disponíveis:
SETTLED,
FAILED
parkedAnswerId
string

A parked STR answer of this leg (id from the row's detail.parkedAnswers) the operators declare the leg from.

settledAt
string<date-time>

RFC 3339 instant the STR settled the leg, in the past; required with SETTLED, refused with FAILED.

Exemplo:

"2026-10-30T14:05:00Z"

Resposta

OK

accepted
boolean
obrigatório

Whether the rail accepted the verb. A refusal is an error status, never accepted=false.

correlationId
string
obrigatório

Request-scoped correlation identifier echoing X-Request-ID.

requirement
string
obrigatório

Gating tier the verb resolved to: DIRECT, APPROVAL_REQUIRED, or ADVISORY.

Exemplo:

"APPROVAL_REQUIRED"

railActionRef
string

Rail-native reference for follow-up: the case the approval acts on.

reasonCode
string

Stable machine code for display and telemetry only.

resultState
string

Canonical operation state after the verb, when it moved one.