Skip to main content
POST
Stop a Mensageria permanent block by hand

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

orderId
string
required

The identifier of the original BLOQUEIO order of the Mensageria permanent (UUID), never the INTERRUPT's.

Example:

"0b9b7c2e-4f8a-4d3e-9a51-7c2d1e0f3a44"

Body

application/json
reason
string

Required. Short justification or ticket (at most 200 characters, no personal data). Never echoed.

Example:

"OPS-4512: court stop received by the client's operator."

Response

OK

closeReason
enum<string>
required

INTERRUPTED on STOPPED; on NOOP the reason of the existing close.

Available options:
TARGET_REACHED,
EXPIRED,
RELEASED,
CANCELLED,
INTERRUPTED
closedAt
string<date-time>
required

Instant of the close (UTC): this stop's on STOPPED, the earlier close's on NOOP.

orderId
string
required

The BLOQUEIO order's identifier.

outcome
enum<string>
required

STOPPED: closed now. NOOP: it was already closed, nothing changed and nothing was reported again.

Available options:
STOPPED,
NOOP
status
enum<string>
required

Always CLOSED.

Available options:
CLOSED
stoppedAt
string<date-time>
required

Instant of the request (UTC).

stoppedBy
string
required

Subject of the platform administrator who made the request.