Send Message
Rate limited to 100 requests per hour per organization.
Path Parameters
The unique identifier of the inbox to send from.
Request Body
Array of recipient email addresses.Example:
["[email protected]", "[email protected]"]Array of CC recipient email addresses.
Array of BCC recipient email addresses.
Subject line of the email.
Plain text version of the email body.
HTML version of the email body.
Custom labels to organize the message.Example:
["important", "customer-support"]Array of attachment objects.
Response
Unique identifier for the message.
ID of the organization that owns this message.
ID of the inbox this message belongs to.
ID of the thread this message belongs to.
ID of the inbox the message was sent from.
Email address the message was sent from.
Array of recipient email addresses.
Array of CC recipient email addresses.
Array of BCC recipient email addresses.
Subject line of the email.
Plain text version of the email body.
HTML version of the email body.
Custom labels assigned to the message.
Array of attachment objects.
External message ID from the email service provider (AWS SES).
Status of the message. One of:
sent, received, delivered, bounced, complained, rejected.ISO 8601 timestamp of when the message was created.
ISO 8601 timestamp of when the message was last updated.
Error Responses
404 Not Found"Inbox not found"- The inbox doesn’t exist or doesn’t belong to your organization
- Rate limit exceeded (100 requests per hour)
Webhook Events
Sending a message triggers the following webhook event:message.sent- Fired when the message is successfully sent
Reply to Message
Rate limited to 100 requests per hour per organization.
Path Parameters
The unique identifier of the inbox to send from.
The unique identifier of the message to reply to.
Request Body
Plain text version of the reply.
HTML version of the reply.
Response
Returns a message object with the same fields as the Send Message endpoint.Unique identifier for the reply message.
ID of the thread (same as the original message).
Email address the reply was sent from (the inbox email).
Array containing the original sender’s email address.
Subject line prefixed with “Re: ”.
Plain text version of the reply.
HTML version of the reply.
Error Responses
404 Not Found"Inbox not found"- The inbox doesn’t exist or doesn’t belong to your organization"Message not found"- The message doesn’t exist or doesn’t belong to your organization
- Rate limit exceeded (100 requests per hour)
Webhook Events
Replying to a message triggers the following webhook event:message.sent- Fired when the reply is successfully sent
List Messages
Path Parameters
The unique identifier of the inbox.
Query Parameters
Search query to filter messages. Searches across subject, text, and sender fields.Example:
"important"Response
Returns an array of message objects.Unique identifier for the message.
ID of the organization that owns this message.
ID of the inbox this message belongs to.
ID of the thread this message belongs to.
Email address the message was sent from.
Array of recipient email addresses.
Subject line of the email.
Plain text version of the email body.
HTML version of the email body.
Status of the message.
ISO 8601 timestamp of when the message was created.
Error Responses
404 Not Found"Inbox not found"- The inbox doesn’t exist or doesn’t belong to your organization
Get Message
Path Parameters
The unique identifier of the inbox.
The unique identifier of the message to retrieve.
Response
Unique identifier for the message.
ID of the organization that owns this message.
ID of the inbox this message belongs to.
ID of the thread this message belongs to.
ID of the inbox the message was sent from (if applicable).
Email address the message was sent from.
ID of the inbox the message was sent to (if applicable).
Array of recipient email addresses.
Array of CC recipient email addresses.
Array of BCC recipient email addresses.
Subject line of the email.
Plain text version of the email body.
HTML version of the email body.
Custom labels assigned to the message.
Array of attachment objects with
content, name, and contentType fields.External message ID from the email service provider.
Status of the message. One of:
sent, received, delivered, bounced, complained, rejected.ISO 8601 timestamp of when the message was created.
ISO 8601 timestamp of when the message was last updated.
Error Responses
404 Not Found"Message not found"- The message doesn’t exist or doesn’t belong to your organization