light-mode-image
Learn
API ReferenceInboxes

Retrieve an inbox

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_INBOX_RETRIEVE_STARTMESSAGING_INBOX_RETRIEVE_SUCCESSMESSAGING_INBOX_RETRIEVE_FAIL
GET/v1/messaging/inboxes/{id}

Retrieves an inbox based on its ID.

Analytic events

  • MESSAGING_INBOX_RETRIEVE_START
  • MESSAGING_INBOX_RETRIEVE_SUCCESS
  • MESSAGING_INBOX_RETRIEVE_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Inbox ID

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/messaging/inboxes/string"
{  "id": "string",  "name": "string"}

How would you rate this page?

List inboxes GET

Returns a list of all inboxes on the tenant. ### **Analytic events** * MESSAGING_INBOX_RETRIEVE_LIST_START * MESSAGING_INBOX_RETRIEVE_LIST_SUCCESS * MESSAGING_INBOX_RETRIEVE_LIST_FAIL

Update an inbox PUT

Update the inbox configurations