Learn

Inboxes

Create an inbox

Creates an inbox that can register DIDs and then hold messages sent to those DIDs service points.

Analytic events

  • MESSAGING_INBOX_CREATE_START
  • MESSAGING_INBOX_CREATE_SUCCESS
  • MESSAGING_INBOX_CREATE_FAIL
SecuritybearerAuth
Request
Request Body schema: application/json
required

Inbox configuration

name
required
string non-empty

Inbox name.

Responses
201

Inbox created

400

Bad request

post/core/v1/messaging/inboxes
Request samples
application/json
{
  • "name": "My_Inbox"
}
Response samples
application/json
{
  • "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
  • "name": "My_Inbox"
}

List inboxes

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
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of the list, default 100

Example: limit=2
cursor
string

Starting point for the list

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

A list of inboxes

get/core/v1/messaging/inboxes
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
Retrieve an inbox
Retrieves an inbox based on its ID.


Analytic events


    

  • MESSAGING_INBOX_RETRIEVE_START
    • 

  • MESSAGING_INBOX_RETRIEVE_SUCCESS
    • 

  • MESSAGING_INBOX_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Inbox ID


 
Responses 
200
Inbox returned


400
Bad Request


404
Not Found


get/core/v1/messaging/inboxes/{id}
Request samples 
Response samples 
application/json
{
  • "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
  • "name": "My_Inbox"
}
Update an inbox
Update the inbox configurations


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Inbox ID


 
Request Body schema: application/json
required
Updates an inbox name.


Analytic events


    

  • MESSAGING_INBOX_UPDATE_START
    • 

  • MESSAGING_INBOX_UPDATE_SUCCESS
    • 

  • MESSAGING_INBOX_UPDATE_FAIL
    • 



name
required
string  non-empty 
 
Responses 
200
Inbox updated


400
Bad Request


404
Not Found


put/core/v1/messaging/inboxes/{id}
Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
  • "name": "My_Inbox"
}
Delete an inbox
Deletes an inbox by providing its ID.


Analytic events


    

  • MESSAGING_INBOX_DELETE_START
    • 

  • MESSAGING_INBOX_DELETE_SUCCESS
    • 

  • MESSAGING_INBOX_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Inbox ID


 
Responses 
204
Inbox deleted


400
Bad Request


404
Not Found


delete/core/v1/messaging/inboxes/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
Register DID with an inbox
Register the provided DID to the requested inbox.




DID registration with inboxes is currently limited to did:key'




Analytic events


    

  • MESSAGING_INBOX_DID_REGISTER_START
    • 

  • MESSAGING_INBOX_DID_REGISTER_SUCCESS
    • 

  • MESSAGING_INBOX_DID_REGISTER_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
Request Body schema: application/json
required
DID registration information


did
required
string
URI of the DID to register with this inbox.


 
jwt
string
 
Responses 
201
DID registered with inbox


400
Bad Request


404
Not Found


post/core/v1/messaging/inboxes/{id}/dids
Request samples 
application/json
{
  • "did": "string",
  • "jwt": "string"
}
Response samples 
application/json
{
  • "did": "string"
}
Retrieve inbox DIDs
Retrieves a list of all the DIDs registered with the requested inbox.


Analytic events


    

  • MESSAGING_INBOX_DID_RETRIEVE_LIST_START
    • 

  • MESSAGING_INBOX_DID_RETRIEVE_LIST_SUCCESS
    • 

  • MESSAGING_INBOX_DID_RETRIEVE_LIST_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
A list of inbox DIDs


400
Bad Request


404
Not Found


get/core/v1/messaging/inboxes/{id}/dids
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Unregister DID with an inbox
Unregisters a DID from the requested inbox.


Analytic events


    

  • MESSAGING_INBOX_DID_UNREGISTER_START
    • 

  • MESSAGING_INBOX_DID_UNREGISTER_SUCCESS
    • 

  • MESSAGING_INBOX_DID_UNREGISTER_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
did
required
string
DID


 
 Example:  did:key:z6Mkjr7vfzBfamiN6Wi6cyQUgTq6CEMXP1MzWQawsUEXJoa9
Responses 
204
DID unregistered from inbox


400
Bad Request


404
Not Found


delete/core/v1/messaging/inboxes/{id}/dids/{did}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
Retrieve all messages
Retrieving all the messages from an inbox


Analytic events


    

  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_START
    • 

  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_SUCCESS
    • 

  • MESSAGING_INBOX_MESSAGE_RETRIEVE_LIST_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
A list of inbox messages


400
Bad Request


404
Not Found


get/core/v1/messaging/inboxes/{id}/messages
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve a message
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
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
messageid
required
string
Requested message ID


 
Responses 
200
An inbox message


400
Bad Request


404
Not Found


get/core/v1/messaging/inboxes/{id}/messages/{messageid}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "createdAt": "2019-08-24",
  • "id": "string",
  • "inboxId": "string",
  • "payload": "string"
}
Delete a message
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
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string
Requested inbox ID


 
messageid
required
string
Requested message ID


 
Responses 
204
Message deleted


400
Bad Request


404
Not Found


delete/core/v1/messaging/inboxes/{id}/messages/{messageid}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
➔ Next to Security