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

Welcome to Instantly. Let’s get started with getting you authenticated and ready to build! 🛠️<h3>Finding your API key 🗝️</h3>The first step to using the Instantly API platform is to find your API key. The API key helps authenticate your incoming requests and is unique per Instantly workspace.

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

The first step to using the Instantly API platform is to find your API key. 

The API key helps authenticate your incoming requests and is unique per Instantly workspace.

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

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

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

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

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

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

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

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

api_key

limit

skip

accounts

This endpoint allows you to quickly check if the MX, SPF, DKIM, and DMARC records have been properly set for a list of domains.

This endpoint allows you to quickly check if the MX, SPF, DKIM, and DMARC records have been properly set for a list of domains.

status

success_list

failure_list

email

account

warmup_status

Email address to update warmup status for

<div data-type="info" style="background-color:#eef1ff;color:#4a59af"><div ><svg focusable="false" preserveAspectRatio="xMidYMid meet" xmlns="http://www.w3.org/2000/svg" fill="currentColor" width="16" height="16" viewBox="0 0 32 32" aria-hidden="true"><path fill="none" d="M16,8a1.5,1.5,0,1,1-1.5,1.5A1.5,1.5,0,0,1,16,8Zm4,13.875H17.125v-8H13v2.25h1.875v5.75H12v2.25h8Z" data-icon-path="inner-path"></path><path d="M16,2A14,14,0,1,0,30,16,14,14,0,0,0,16,2Zm0,6a1.5,1.5,0,1,1-1.5,1.5A1.5,1.5,0,0,1,16,8Zm4,16.125H12v-2.25h2.875v-5.75H13v-2.25h4.125v8H20Z"></path></svg></div><div >To mark all accounts as fixed, skip the <code class="slate-code">email</code> parameter in the request body.</div></div>

(Optional) Email address to mark as fixed; set to false or skip this parameter to mark all accounts as fixed. 

<div data-type="info" style="background-color:#eef1ff;color:#4a59af"><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 >See the “Custom Tracking Domain” section for details on how to add, update, and remove custom tracking domains for sending accounts.<a href="https://developer.instantly.ai/custom-tracking-domain" target="_blank">https://developer.instantly.ai/custom-tracking-domain</a></div></div>

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

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

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.Resource Ty

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.

The Verification endpoints allow you to verify emails, including those behind catch-all domains.See below for details.There are currently two categories of verification endpoints.<ol></ol>

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

There are currently two categories of verification endpoints.

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.Help article:
<a href="https://help.instantly.ai/en/articles/6984188-custom-tracking-domain" target="_blank">https://help.instantly.ai/en/articles/6984188</a>

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.