Download OpenAPI specification:Download
Contains functionality around conversations.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Retrieves all conversation types.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
[- {
- "id": 0,
- "name": "string",
- "key": "string",
- "nameResourceKey": "string"
}
]Retrieves the number of unread conversation thread and messages.
| includeUnreadMessageCount | boolean Read receipt unread count parameter |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "unreadConversation": 0,
- "unreadMessageCount": [
- {
- "conversationId": 0,
- "unreadMessages": 0
}
]
}Creates a new conversation. If the person is a member, they should be able to initiate a conversation with a contact if member have hierarchy access to the contact. They can message another member if they are part of same participant. If the person is a contact, they can initiate a conversation with a member if the member is their direct advisor.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request body
| senderUId | string <uuid> Nullable Target persons to start the conversation with |
| personUIds | Array of strings <uuid> Nullable Sender of the message in the conversation. Nullable |
| subject | string Nullable Subject line of the conversation |
| body | string Nullable Content of the initial message |
| conversationTypeId | integer <int32> Id representing the message type |
| customAttributes | string Nullable Optional metadata filters |
| attachments | Array of objects (MessageAttachmentRequest) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "senderUId": "ed50f78f-bf6e-4701-bd67-f47f5a165cf1",
- "personUIds": [
- "655eb410-641b-421a-95b3-a3c9f997f2ec",
- "f5533f8f-0e0a-4072-8571-f99823ee156e"
], - "subject": "Lost Credit Card",
- "body": "Dear Relationship Manager, I lost my credit card today! Can you please block it and order a new one?",
- "conversationTypeId": 1,
- "customAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
- "attachments": [
- {
- "fileName": "file1.pdf",
- "file": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUgo+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9QYWdlcwovQ291bnQgMAo+PgplbmRvYmoKeHJlZgowIDMKMDAwMDAwMDAgNjU1MzUgZgowMDAwMDAwMSAwMDAwMCBuCjAwMDAwMDA3IDAwMDAwIG4KdHJhaWxlcgo8PC9Sb290IDEgMCBSCi9TaXplIDMKPj4Kc3RhcnR4cmVmCjM0NgolJUVPRg=="
}, - {
- "fileName": "file2.pdf",
- "file": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUgo+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9QYWdlcwovQ291bnQgMAo+PgplbmRvYmoKeHJlZgowIDMKMDAwMDAwMDAgNjU1MzUgZgowMDAwMDAwMSAwMDAwMCBuCjAwMDAwMDA3IDAwMDAwIG4KdHJhaWxlcgo8PC9Sb290IDEgMCBSCi9TaXplIDMKPj4Kc3RhcnR4cmVmCjM0NgolJUVPRg=="
}
]
}{- "conversationId": 1,
- "messageId": 1
}Sends a new message in existing conversation thread or reply to specific message in the thread. A person should be able to reply to a message if they are part of hierarchy access of at least one person in the conversation.
| conversationId required | integer <int32> Id of the conversation |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request body
| senderUId | string <uuid> Nullable Sender of the message in the conversation (nullable) |
| replyMessageId | integer <int64> Nullable Id of the message being replied to (nullable) |
| body | string Nullable Content of the message |
| customAttributes | string Nullable Optional metadata filters |
| attachments | Array of objects (MessageAttachmentRequest) Nullable The list of the message attachments (file name and content of the file). |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "senderUId": "f4610a70-b8a5-4ba1-b698-1d5b97686a7a",
- "replyMessageId": 1,
- "body": "Dear Relationship Manager, I lost my credit card today! Can you please block it and order a new one?",
- "customAttributes": "{\"RecipientClientFilters\" : [19, 20]}",
- "attachments": [
- {
- "fileName": "file1.pdf",
- "file": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUgo+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9QYWdlcwovQ291bnQgMAo+PgplbmRvYmoKeHJlZgowIDMKMDAwMDAwMDAgNjU1MzUgZgowMDAwMDAwMSAwMDAwMCBuCjAwMDAwMDA3IDAwMDAwIG4KdHJhaWxlcgo8PC9Sb290IDEgMCBSCi9TaXplIDMKPj4Kc3RhcnR4cmVmCjM0NgolJUVPRg=="
}, - {
- "fileName": "file2.pdf",
- "file": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUgo+PgplbmRvYmoKMiAwIG9iago8PC9UeXBlIC9QYWdlcwovQ291bnQgMAo+PgplbmRvYmoKeHJlZgowIDMKMDAwMDAwMDAgNjU1MzUgZgowMDAwMDAwMSAwMDAwMCBuCjAwMDAwMDA3IDAwMDAwIG4KdHJhaWxlcgo8PC9Sb290IDEgMCBSCi9TaXplIDMKPj4Kc3RhcnR4cmVmCjM0NgolJUVPRg=="
}
]
}{- "messageId": 1
}Set status of the message in conversation as read
| conversationId required | integer <int32> Id of the conversation |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request body
| messageId | integer <int64> Id of the Message to be marked read |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "messageId": 1
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}