light-mode-image
Learn
MATTR VII PlatformInboxes

Delete an inbox

Deletes an inbox by providing its ID.

Analytics Events

MESSAGING_INBOX_DELETE_STARTMESSAGING_INBOX_DELETE_SUCCESSMESSAGING_INBOX_DELETE_FAIL

Roles

adminissuer
DELETE/v1/messaging/inboxes/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Inbox ID

Response Body

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

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

How would you rate this page?