instantly.ai

Introduction

Test your API key

Rate limits

Campaign

List campaigns

Get campaign name

Get campaign status

Set campaign name

Get campaign accounts

Set campaign accounts

Add sending account to campaign

Remove sending account from campaign

Set campaign schedule

Launch campaign

Pause campaign

Analytics

Get campaign summary

Get campaign count

Lead

Add leads to a campaign

Get or search for lead

Delete leads from a campaign

Update lead status

Lead Variable | Update

Lead Variable | Set

Lead Variable | Delete

Blocklist

Add entries to blocklist

Remove entries from blocklist

Account

List accounts

Check account vitals

Get account status

Enable warmup

Pause warmup

Mark accounts as fixed

Delete account

Updating Custom Tracking Domain

Unibox

Emails | List

Emails | Count Unread

Threads | Mark as read

Send Reply

More coming soon

Create a new Tag

Get a Tag by id

List Tags

Update Tag

Delete a Tag

Assign or unassign a tag

Email Verification

Verify single email

Get single email verification result

Custom Tracking Domain

Add a custom tracking domain

Get status of tracking domain host

Remove tracking domain

Default

Instantly API Docs

Instantly API Documentation

API Key

<p class="slate-p " >Welcome to Instantly. Let’s get started with getting you authenticated and ready to build! 🛠️</p><p class="slate-p " ></p><h3 class="slate-h3 " >Finding your API key 🗝️</h3><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Go to Instantly Dashboard </h3><p class="slate-p " >The first step to using the Instantly API platform is to find your API key.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Go to Settings → Integrations</h3><p class="slate-p " >To get to your API key, go to your: Instantly Dashboard  → Settings → Integrations → API</p><p class="slate-p " ><a href="https://app.instantly.ai/app/settings/integrations" target="_self">https://app.instantly.ai/app/settings/integrations</a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Retrieve your API key</h3><p class="slate-p " >The API key helps authenticate your incoming requests and is unique per Instantly workspace.</p></div></div></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >You need to be on the Hypergrowth plan (or above) to be able to access the API key.</p></div></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"></p><p class="slate-p " ></p><p class="slate-p " ></p>

Welcome to Instantly. Let’s get started with getting you authenticated and ready to build! 🛠️

<p class="slate-p " >The campaign endpoints allow you to interact with individual email campaigns, update their options, sending accounts, and status. See below for details.</p><p class="slate-p " ></p>

The campaign endpoints allow you to interact with individual email campaigns, update their options, sending accounts, and status. See below for details.

<p class="slate-p " >The campaign endpoints allow you to interact with individual email campaigns, update their options, sending accounts, and status. See below for details.</p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " >The lead endpoints allow you to interact with lead data in your workspace.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The lead endpoints allow you to interact with lead data in your workspace.

<p class="slate-p " >The blocklist endpoints allow you to interact with your campaign blocklist. See below for details.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The blocklist endpoints allow you to interact with your campaign blocklist. See below for details.

<p class="slate-p " >The account endpoints allow you to interact with your sending accounts. See below for details.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The account endpoints allow you to interact with your sending accounts. See below for details.

<p class="slate-p " >The account endpoints allow you to interact with the Instantly Unibox. See below for details.</p><p class="slate-p " ></p>

The account endpoints allow you to interact with the Instantly Unibox. See below for details.

<p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Note: </strong>The <code class="slate-code">body</code> of the email object is only sent when you have <code class="slate-code">preview_only=false</code> (i.e., the default state is to send the content preview only). The <code class="slate-code">body</code> object may have a property called <code class="slate-code">text</code> and/or <code class="slate-code">html,</code> depending on the original content of the email.</p><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" data-type=info ><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >The <span style="background-color:var(--vscode-textPreformat-background);color:var(--vscode-textPreformat-foreground)"><code class="slate-code">email_type</code></span> parameter now accepts a new value <span style="background-color:var(--vscode-textPreformat-background);color:var(--vscode-textPreformat-foreground)"><code class="slate-code">manual</code></span>. When applied, it will return the following email types:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Sent manually through the Unibox</div></li><li class="slate-li " ><div style="position:relative">Received emails (responses from leads)</div></li><li class="slate-li " ><div style="position:relative">Emails scheduled to be sent (from the Unibox)</div></li></ol></div></div><p class="slate-p " ></p>

 of the email object is only sent when you have 

 (i.e., the default state is to send the content preview only). The 

 depending on the original content of the email.

api_key

Set to false if you only want the email content's preview and not the full body

preview_only

Email address of lead (optional) - only fetch emails for a specific lead

lead

Campaign id (optional) - only fetch emails for a specific campaign

campaign_id

Set to true if you only want to fetch sent emails - only 

sent_emails

email_type

Set to true if you want to only fetch the latest email per thread

latest_of_thread

Used for pagination - returned in the response

page_trail

Used for pagination - you can pass this on to fetch the next page

data

<p class="slate-p " ></p><p class="slate-p " >Get the number of unread emails in the “Primary” box.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Get the number of unread emails in the “Primary” box.

count

<p class="slate-p " ></p><p class="slate-p " >This endpoint marks all emails in a thread as read.</p><p class="slate-p " ></p><div style="width:60%;
	min-width:60%;" data-type=info ><div ><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >The thread id should be passed in the URL and not the POST body (see example code).</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p>

This endpoint marks all emails in a thread as read.

thread_id

<p class="slate-p " ></p><p class="slate-p " >Send an email reply through Unibox</p><p class="slate-p " ></p><p class="slate-p " ></p>

reply_to_uuid

subject

from

body

The email addresses to be included in the CC field.

The email addresses to be included in the BCC field.

The timestamp for setting a reminder for the email reply.

reminder_ts

The timestamp for scheduling the email reply to be sent.

scheduled_at

status

message_id

message

Invalid request data or validation errors.

The email being replied to does not exist.

An error occurred while sending the email reply.

<p class="slate-p " >The Unibox API docs are currently being tested and deployed; we'll add more sections soon. For early access, please contact support.</p><p class="slate-p " ></p><p class="slate-p " ></p>

The Unibox API docs are currently being tested and deployed; we'll add more sections soon. For early access, please contact support.

<p class="slate-p " >The custom tag endpoints are a set of endpoints that allow you to manage custom tags and associate them with specific resources. Custom tags are labels or categories that you can assign to different entities, such as user accounts or campaigns, to organize and group them based on certain criteria.</p><p class="slate-p " ></p><p class="slate-p " ><strong class="slate-bold">Resource Type and Resource ID:</strong>
The resource type and resource ID are used to uniquely identify a specific resource.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resource Type</strong>: The resource type is a way to categorize different types of resources in your application. It helps distinguish between different entities that can have custom tags assigned to them. For example, you might have resource types such as "<strong class="slate-bold">account</strong>" for user accounts and "<strong class="slate-bold">campaign</strong>" for marketing campaigns.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resource ID</strong>: The resource ID is a unique identifier for a specific resource within a resource type. It allows you to reference a particular resource when assigning or retrieving custom tags. For example, if you have a user <strong class="slate-bold">account</strong> with an email address "<a href="mailto:johndoe@instantly.ai" target="_blank">johndoe@instantly.ai</a>", the email address would be the resource ID for the "<strong class="slate-bold">account</strong>" resource type.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

The custom tag endpoints are a set of endpoints that allow you to manage custom tags and associate them with specific resources. Custom tags are labels or categories that you can assign to different entities, such as user accounts or campaigns, to organize and group them based on certain criteria.


The resource type and resource ID are used to uniquely identify a specific resource.

<p class="slate-p " >The Verification endpoints allow you to verify emails, including those behind catch-all domains.</p><p class="slate-p " >See below for details.</p><p class="slate-p " >There are currently two categories of verification endpoints.</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Submitting a verification job</div></li><li class="slate-li " ><div style="position:relative">Checking the status of a verification job</div></li></ol><p class="slate-p " ></p>

The Verification endpoints allow you to verify emails, including those behind catch-all domains.

There are currently two categories of verification endpoints.

<p class="slate-p " >The Custom Tracking Domain endpoints allow you to add, remove, or check status of custom tracking domains that are used for tracking campaign metrics such as opens, link clicks, etc.</p><p class="slate-p " ></p><p class="slate-p " >Help article:
<a href="https://help.instantly.ai/en/articles/6984188-custom-tracking-domain" target="_blank">https://help.instantly.ai/en/articles/6984188-custom-tracking-domain</a> </p><p class="slate-p " ></p>

The Custom Tracking Domain endpoints allow you to add, remove, or check status of custom tracking domains that are used for tracking campaign metrics such as opens, link clicks, etc.