light-mode-image
Learn
API ReferenceInboxes

Delete a message

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_MESSAGE_DELETE_STARTMESSAGING_INBOX_MESSAGE_DELETE_SUCCESSMESSAGING_INBOX_MESSAGE_DELETE_FAIL
DELETE/v1/messaging/inboxes/{id}/messages/{messageid}

Deletes a message from the requested inbox by providing its ID.

Analytic events

  • MESSAGING_INBOX_MESSAGE_DELETE_START
  • MESSAGING_INBOX_MESSAGE_DELETE_SUCCESS
  • MESSAGING_INBOX_MESSAGE_DELETE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Requested inbox ID

messageid*string

Requested message ID

Response Body

application/json

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v1/messaging/inboxes/string/messages/string"
Empty

{
  "code": "BadRequest",
  "message": "Validation Error",
  "details": [
    {
      "value": "notUUIDvalue",
      "msg": "Invalid value",
      "param": "inboxId",
      "location": "params"
    }
  ]
}

{
  "code": "NotFound",
  "message": "Resource Not Found"
}

How would you rate this page?

Retrieve a message GET

Retrieves a message from the requested inbox by providing its ID. ### **Analytic events** * MESSAGING_INBOX_MESSAGE_RETRIEVE_START * MESSAGING_INBOX_MESSAGE_RETRIEVE_SUCCESS * MESSAGING_INBOX_MESSAGE_RETRIEVE_FAIL

Create API Auth Token POST

Authorization endpoint for gaining token used for API requests requiring `bearerAuth`. You will be provided the required `client_id` and `client_secret` as part of onboarding. > The returned bearer token will only enable access to endpoints as per your client's defined role. Refer to [Access Control](https://learn.mattr.global/docs/platform-management/access-control) for more information.