Inboxes

An inbox on MATTR VII allows users a place where messages can be stored.

MATTR VII users are able to perform CRUD actions on an inbox. Retrieve a list of inboxes to show all registered inboxes to a tenant. Register and unregister a DID to an inbox.

When an inbox is created, MATTR VII users will now have a place to store and retrieve their messages.

Create an Inbox

Creating an inbox allows the ability to store, view and delete messages. This also allows MATTR VII users to register and unregister a specific DID from an inbox.

Request

1POST https://YOUR_TENANT_URL/v1/messaging/inboxes

1{  
2    "name": "Test Inbox 01"
3}

The inbox name must be unique.

No two inboxes can ever have the same name in one tenant.

Response

1{
2    "id": "2100dcd7-ebef-401d-a638-3eb77cea82f2",
3    "name": "Test Inbox 01"
4}

The response when a successful inbox is created  has a common structure using JSON. This includes : 

id - that is used to uniquely identify the inbox

name - that is used to show the name of an inbox that was given

Update an Inbox

Updating an inbox allows MATTR VII users the ability to change the inbox name.

Request

1PUT https://YOUR_TENANT_URL/v1/messaging/inboxes/{{id}}

1
2{  
3    "name": "Test Inbox 02"
4}

Response

1
2{
3    "id": "2100dcd7-ebef-401d-a638-3eb77cea82f2",
4    "name": "Test Inbox 02"
5}

A successful response changes the name of the inbox to the desired name from the request.

Delete an Inbox

Updating an inbox allows MATTR VII users the ability to remove an inbox completely.

Request

1DELETE https://YOUR_TENANT_URL/v1/messaging/inboxes/{{id}}

The response would be a 204 inbox deleted.