Send Message
Rate limited to 100 requests per hour per organization.
Path Parameters
string
required
The unique identifier of the inbox to send from.
Request Body
string[]
required
Array of recipient email addresses.Example:
["recipient@example.com", "another@example.com"]string[]
Array of CC recipient email addresses.
string[]
Array of BCC recipient email addresses.
string
required
Subject line of the email.
string
required
Plain text version of the email body.
string
required
HTML version of the email body.
string[]
Custom labels to organize the message.Example:
["important", "customer-support"]array
Array of attachment objects.
Response
string
Unique identifier for the message.
string
ID of the organization that owns this message.
string
ID of the inbox this message belongs to.
string
ID of the thread this message belongs to.
string
ID of the inbox the message was sent from.
string
Email address the message was sent from.
string[]
Array of recipient email addresses.
string[]
Array of CC recipient email addresses.
string[]
Array of BCC recipient email addresses.
string
Subject line of the email.
string
Plain text version of the email body.
string
HTML version of the email body.
string[]
Custom labels assigned to the message.
array
Array of attachment objects.
string
External message ID from the email service provider (AWS SES).
string
Status of the message. One of:
sent, received, delivered, bounced, complained, rejected.string
ISO 8601 timestamp of when the message was created.
string
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
string
required
The unique identifier of the inbox to send from.
string
required
The unique identifier of the message to reply to.
Request Body
string
required
Plain text version of the reply.
string
required
HTML version of the reply.
Response
Returns a message object with the same fields as the Send Message endpoint.string
Unique identifier for the reply message.
string
ID of the thread (same as the original message).
string
Email address the reply was sent from (the inbox email).
string[]
Array containing the original sender’s email address.
string
Subject line prefixed with “Re: ”.
string
Plain text version of the reply.
string
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
string
required
The unique identifier of the inbox.
Query Parameters
string
Search query to filter messages. Searches across subject, text, and sender fields.Example:
"important"Response
Returns an array of message objects.string
Unique identifier for the message.
string
ID of the organization that owns this message.
string
ID of the inbox this message belongs to.
string
ID of the thread this message belongs to.
string
Email address the message was sent from.
string[]
Array of recipient email addresses.
string
Subject line of the email.
string
Plain text version of the email body.
string
HTML version of the email body.
string
Status of the message.
string
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
string
required
The unique identifier of the inbox.
string
required
The unique identifier of the message to retrieve.
Response
string
Unique identifier for the message.
string
ID of the organization that owns this message.
string
ID of the inbox this message belongs to.
string
ID of the thread this message belongs to.
string
ID of the inbox the message was sent from (if applicable).
string
Email address the message was sent from.
string
ID of the inbox the message was sent to (if applicable).
string[]
Array of recipient email addresses.
string[]
Array of CC recipient email addresses.
string[]
Array of BCC recipient email addresses.
string
Subject line of the email.
string
Plain text version of the email body.
string
HTML version of the email body.
string[]
Custom labels assigned to the message.
array
Array of attachment objects with
content, name, and contentType fields.string
External message ID from the email service provider.
string
Status of the message. One of:
sent, received, delivered, bounced, complained, rejected.string
ISO 8601 timestamp of when the message was created.
string
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