API ReferenceInboxes
Update an inbox
Roles
adminissuermanaged-issuer
PUT
/v1/messaging/inboxes/{id}Update the inbox configurations
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Inbox ID
Request Body
application/json
Updates an inbox name.
Analytic events
- MESSAGING_INBOX_UPDATE_START
- MESSAGING_INBOX_UPDATE_SUCCESS
- MESSAGING_INBOX_UPDATE_FAIL
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/messaging/inboxes/string" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "id": "string", "name": "string"}How would you rate this page?
Retrieve an inbox GET
Retrieves an inbox based on its ID. ### **Analytic events** * MESSAGING_INBOX_RETRIEVE_START * MESSAGING_INBOX_RETRIEVE_SUCCESS * MESSAGING_INBOX_RETRIEVE_FAIL
Delete an inbox DELETE
Deletes an inbox by providing its ID. ### **Analytic events** * MESSAGING_INBOX_DELETE_START * MESSAGING_INBOX_DELETE_SUCCESS * MESSAGING_INBOX_DELETE_FAIL