...
| Method | URI | Body | Parameters | Return | Description | Permission | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| /message/inbox | Sorting + pagination | Paginated results<MessageBundle> | Gets all messages the authenticated user has received | Authenticated User | |||||||||
| /message/outbox | Sorting + pagination | Paginated results<Message> | Gets all messages the authenticated user has sent | Authenticated User | ||||||||
| /message | Message | inReplyTo=null (i.e. another Message) | Message | Sends a message. Note, message delivery permission is on a recipient-by-recipient basis, asynchronous to the message creation. Unauthorized delivery may result in silent failure or a bounce message (TBD). | Authenticated User
Must be admin to send to AUTH_USERS Must have SEND_MESSAGE permission on team to send to team | |||||||
| /message/{id}/forward | RecipientBundle | Forwards a message to other recipients. This is equivalent to getting a (visible) message and POST-ing it to /message | Sender or Receiver | |||||||||
| /entity/{id}/comments | Message | Message | Convenience method for commenting on an entity. The service fills out fields like message ID, thread ID, and recipients, leaving just subject and body for the user. | Authenticated user with SEND_MESSAGE permission on entity | ||||||||
| Sorting + pagination | Paginated results<MessageBundle> | Gets all messages the authenticated user has received | Authenticated User | |||||||||
| /message/outbox | Sorting + pagination | Paginated results<Message> | Gets all messages the authenticated user has sent | Authenticated User | ||||||||
| /message/{id} | Message | Gets a specific message | Sender or Receiver | |||||||||
| /message/{id}/forward | RecipientBundle | Message | Gets a specific Forwards a message to other recipients. This is equivalent to getting a (visible) message and POST-ing it to /message | Sender or Receiver | ||||||||
| /message/{id}/conversation | Sorting + pagination | Paginated results<Message> | Gets messages belonging in the same thread as the message ID. The list is filtered according to the user's ID. | Sender or Receiver |
| /entity/{id}/comments | Sorting + pagination | Paginated results<Message> | Gets message belonging to the thread tied to the entity. | Authenticated user with READ permission on entity|||
| /message/{id}/status | Message Status | Gets the status of a message | Receiver | |||||||||
| /message/status | MessageStatus | Marks a message as:
| Receiver | |||||||||
| /entity/{id}/comments | Message | Message | Convenience method for commenting on an entity. The service fills out fields like message ID, thread ID, and recipients, leaving just subject and body for the user. | Authenticated user with SEND_MESSAGE permission on entity | ||||||||
| /entity/{id}/comments | Sorting + pagination | Paginated results<Message> | Gets message belonging to the thread tied to the entity. | Authenticated user with READ permission on entity | ||||||||
| /message/settings | MessageSettings | Gets the notification settings of the user | Authenticated User | |||||||||
| /message/settings | MessageSettings | Changes notification settings | Authenticated User |