Mark as failed

Sets the message status as failed and sends an error message for logging purposes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

A message should be marked as failed if the receiver's back-end system could not import it.

For more information about message statuses, see Message flow.


🚧

Setting the inbound message to a failed state can be used to indicate it could not been parsed and processed by the back-end system, for example it failed to map a unit of measure code, failed to handle payment means, etc.

However, messages should never be left in this state for long. They should be retried as soon as the issue has been resolved in the back-end system or they should be manually parked.

Path Params
uuid
required

The identifier of the message in the format of a valid Universally unique identifier (GUID).

Query Params
string
required

A meaningful message detailing why the message failed.
The message is stored in log and trace messages.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

Status successfully set.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/xml