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
Inbox created
Bad Request. The request was malformed or missing required parameters.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "My_Inbox"
}- 201
- 400
{- "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
A list of inboxes
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
{- "data": [
- {
- "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
- "name": "My_Inbox"
}, - {
- "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
- "name": "My_Inbox"
}
], - "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
Inbox returned
Bad Request. The request was malformed or missing required parameters.
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "id": "f04faabf-cea8-4f39-95b3-0ce357ac4d03",
- "name": "My_Inbox"
}Update an inbox
Update the inbox configurations
Inbox updated
Bad Request
Not Found. The specified resource was not found.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "name": "string"
}- 200
- 400
- 404
{- "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
Inbox deleted
Bad Request
Bad Request. The request was malformed or missing required parameters.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "BadRequest",
- "message": "Validation Error",
- "details": [
- {
- "value": "notUUIDvalue",
- "msg": "Invalid value",
- "param": "inboxId",
- "location": "params"
}
]
}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
DID registered with inbox
Bad Request
Not Found. The specified resource was not found.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
{- "did": "string",
- "jwt": "string"
}- 201
- 400
- 404
{- "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
A list of inbox DIDs
Bad Request
Bad Request. The request was malformed or missing required parameters.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- "did:key:did1",
- "did:key:did2",
- "did:key:did3"
]
}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
DID unregistered from inbox
Bad Request
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "BadRequest",
- "message": "Validation Error",
- "details": [
- {
- "value": "notUUIDvalue",
- "msg": "Invalid value",
- "param": "inboxId",
- "location": "params"
}
]
}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
A list of inbox messages
Bad Request
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
- "data": [
- {
- "name": "string",
- "createdAt": "2019-08-24",
- "id": "string",
- "inboxId": "string",
- "payload": "string"
}, - {
- "name": "string",
- "createdAt": "2019-08-24",
- "id": "string",
- "inboxId": "string",
- "payload": "string"
}
]
}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
An inbox message
Bad Request
Not Found. The specified resource was not found.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "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
Message deleted
Bad Request
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "BadRequest",
- "message": "Validation Error",
- "details": [
- {
- "value": "notUUIDvalue",
- "msg": "Invalid value",
- "param": "inboxId",
- "location": "params"
}
]
}