...
| Method | URI | Body | Parameters | Return | Description | Permission | ||
|---|---|---|---|---|---|---|---|---|
| /message | Message | inReplyTo=null (i.e. another Message) | MessageMessageToUser | MessageToUser | 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/inbox | Sorting + pagination | Paginated results<MessageBundle> | Gets all messages the authenticated user has received | Authenticated User | |||
| /message/outbox | Sorting + pagination | Paginated results<Message>MessageToUser> | Gets all messages the authenticated user has sent | Authenticated User | |||
| /message/{id} | MessageMessageToUser | Gets a specific message | Sender or Receiver | ||||
| /message/{id}/forward | MessageRecipientSet | MessageMessageToUser | 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<MessageMessageToUser> | Gets messages belonging in the same thread as the message ID. The list is filtered according to the user's ID. | Sender or Receiver | |||
| /message/status | MessageStatus | Marks a message as:
| Receiver | ||||
| /entity/{id}/commentsMessagemessage | MessageToUser | MessageToUser | Sends a message to the creator or administrator of the given entity. This allows users to ask for permission to see restricted entities. | Authenticated user | |||
| /entity/{id}/comments | Comment | MessageComment | Convenience method 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<MessageComment> | Gets message messages belonging to the thread tied to the entity. | Authenticated user with READ permission on entity |