Inbound API
Read the email your inboxes receive, and work the shared inbox: reply, assign, set status, leave notes and act on unsubscribe requests.
- GETList received messages
/v1/inbound/messagesList the messages your inboxes received, newest first.
- GETGet a received message
/v1/inbound/messages/{id}Read one received message with its text, sanitized HTML, the new part without quoted history (strippedText) and attachment links that work for 15 minutes.
- GETDownload the original message
/v1/inbound/messages/{id}/rawDownload the original message exactly as it arrived, as an .eml file.
- GETList a message's attachments
/v1/inbound/messages/{id}/attachmentsList the files attached to one received message: id, file name, the type the sender gave, size, and the content id of inline images.
- GETDownload an attachment
/v1/inbound/messages/{id}/attachments/{attachmentId}Download one attachment.
- GETGet a download link for an attachment
/v1/inbound/messages/{id}/attachments/{attachmentId}/linkThe attachment's details and a link that downloads it, valid for 5 minutes.
- GETGet a reply thread
/v1/inbound/conversations/{id}Read a whole conversation, oldest message first: every message the customer sent and every reply the team sent, with the Notix email the first message…
- GETSummarise received mail
/v1/inbound/summaryCounts of what your inboxes received over the last days (7 by default, at most 90): messages, unverified senders, automatic replies and messages that…
- GETList conversations
/v1/inbound/conversationsThe shared inbox's conversations, as its tabs show them.
- GETList a conversation's notes
/v1/inbound/conversations/{id}/notesThe internal notes the team left on a conversation, oldest first (the latest 200).
- POSTAdd a note
/v1/inbound/conversations/{id}/notesLeave an internal note on a conversation, up to 5,000 characters.
- POSTReply to a conversation
/v1/inbound/conversations/{id}/replySend a reply to the customer, in the same thread in their mail app, exactly as the inbox's Reply does: from the inbox's name at your verified sending…
- POSTAssign a conversation
/v1/inbound/conversations/{id}/assignAssign a conversation to someone who works in its inbox (a userId from GET /v1/inbound/inboxes/{inboxId}/members), or pass null to unassign it.
- POSTSet a conversation's status
/v1/inbound/conversations/{id}/statusMark a conversation OPEN, PENDING (answered, waiting for the customer) or CLOSED.
- POSTMark a conversation read
/v1/inbound/conversations/{id}/readMark a conversation read for the key's creator.
- POSTMark a conversation unread
/v1/inbound/conversations/{id}/unreadMark a conversation unread again for the key's creator, until they next open it.
- POSTUnsubscribe the sender
/v1/inbound/conversations/{id}/unsubscribeAct on an unsubscribe request, as the inbox's Unsubscribe button does: the contact the conversation is linked to, who replied to a campaign asking to…
- GETList an inbox's members
/v1/inbound/inboxes/{inboxId}/membersThe people a conversation in this inbox can be assigned to or mention: the inbox's members and the team's admins, with the handle to write after @ in a…
- GETGet the inbox status
/v1/inbound/statusWhether receiving email is set up (configured), the inboxes the key's creator can see with their addresses and open conversations, and the counts behind…