The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.
A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
Send a reply to an email. This endpoint can be used to send an email only as a reply to an existing email. In order to reply to an email, please specify the reyply_to_uuid field, and your email will be sent as a reply to that email. The reyply_to_uuid field represents the id field of an existing email, which is being returned to you in all the /email endpoints
Requires one of the following scopes: emails:create, emails:all, all:create, all:all
The id of the email to reply to
The email account that will be used to send this email. It has to be an email account connected to your workspace
The email body. You can specify either the html or the text field, or both
curl -i -X POST \
https://api.instantly.ai/api/v2/emails/reply \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"eaccount": "jondoe@example.com",
"reply_to_uuid": "123e4567-e89b-12d3-a456-426614174000",
"subject": "Re: Your inquiry",
"body": {}
}'The requested Email
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
curl -i -X GET \
'https://api.instantly.ai/api/v2/emails?assigned_to=123e4567-e89b-12d3-a456-426614174000&campaign_id=123e4567-e89b-12d3-a456-426614174000&company_domain=example.com&eaccount=123e4567-e89b-12d3-a456-426614174000&email_type=received&has_reminder=true&i_status=1&is_unread=true&lead=123e4567-e89b-12d3-a456-426614174000&limit=10&marked_as_done=true&mode=emode_focused&preview_only=true&scheduled_only=true&search=search%20term&sort_order=asc&starting_after=2025-03-07T00%3A00%3A00.000Z' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The list of Email
A Unique identifier
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
Comma-separated list of CC email addresses
Comma-separated list of BCC email addresses
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Timestamp for the reminder.
Indicates if the email is focused (is in the primary tab in the Unibox)
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "items": [ { … } ], "next_starting_after": "0000-0000-0000-0000" }
curl -i -X GET \
'https://api.instantly.ai/api/v2/emails/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Email
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
curl -i -X PATCH \
'https://api.instantly.ai/api/v2/emails/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'The updated Email
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
curl -i -X DELETE \
'https://api.instantly.ai/api/v2/emails/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The deleted Email
Timestamp when the email was added to our database. This is not the timestamp of the email itself, since the email could have been sent at a different time. Please check the timestamp_email field for the timestamp of the email.
The timestamp of the email, as provided by the email server. Please note that the timestamp is not always accurate, as it can be manipulated by the sender or the email server.
Unique email ID from the email server
Comma-separated list of recipient email addresses
An object containing the email body in HTML and text format
The workspace ID
The email account that was used to send the email. This needs to be validated to make sure it exists in the user workspace
The sender email address, populated based on the eaccount
The id of the campaign that the email is associated with (it can be null for manually sent emails)
The id of the campaign subsequence that the email is associated with (it can be null for manually sent emails)
The id of the list (if the lead is part of a list)
Email type based on the life cycle of the email
| Enum Value | Description |
|---|---|
| 1 | Sent from campaign |
| 2 | Received |
| 3 | Sent |
| 4 | Scheduled |
Identifier for the email thread. All the emails in the same thread have the same thread ID
A short preview of the email content (usually the first few lines of the email)
{ "id": "01959271-1f7f-7d76-8a8f-286834e2ee38", "timestamp_created": "2025-03-14T02:17:22.047Z", "timestamp_email": "2025-03-14T02:17:22.047Z", "message_id": "<example123@mail.gmail.com>", "subject": "Re: Your inquiry", "from_address_email": "sender@example.com", "to_address_email_list": "recipient@example.com", "cc_address_email_list": "cc@example.com", "bcc_address_email_list": "bcc@example.com", "reply_to": "replyto@example.com", "body": { "text": "This is a test email", "html": "<p>This is a test email</p>" }, "organization_id": "01959271-1f7f-7d76-8a8f-2869119acdf6", "campaign_id": "01959271-1f7f-7d76-8a8f-286ada9833bd", "subsequence_id": "01959271-1f7f-7d76-8a8f-286bbb2b2346", "list_id": "01959271-1f7f-7d76-8a8f-286cd99afd33", "lead": "01959271-1f7f-7d76-8a8f-286d1e5745c5", "eaccount": "eaccount-123", "ue_type": 3, "step": "step-123", "is_unread": true, "is_auto_reply": false, "reminder_ts": "2025-03-14T02:17:22.047Z", "ai_interest_value": 0.75, "ai_assisted": 1, "is_focused": 1, "i_status": 0, "thread_id": "01959271-1f7f-7d76-8a8f-286ef545e568", "content_preview": "This is a preview of the email content.", "from_address_json": [], "to_address_json": [], "cc_address_json": [] }
curl -i -X GET \
https://api.instantly.ai/api/v2/emails/unread/count \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "count": 100 }
curl -i -X POST \
https://api.instantly.ai/api/v2/emails/threads/123e4567-e89b-12d3-a456-426614174000/mark-as-read \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "success": true }