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 &quot;List campaigns&quot; section allows users to retrieve a list of campaigns associated with their account. Users can view details such as campaign IDs and names, enabling them to manage and track their marketing efforts effectively. Pagination options are available for handling large sets of campaign data.

The "List campaigns" section allows users to retrieve a list of campaigns associated with their account. Users can view details such as campaign IDs and names, enabling them to manage and track their marketing efforts effectively. Pagination options are available for handling large sets of campaign data.

api_key

skip

limit

The &quot;Get campaign name&quot; section allows users to retrieve the name of a specific campaign by providing the campaign ID. This feature is helpful for accessing campaign details and integrating them into external systems or applications. By utilizing this functionality, users can easily access and display campaign names without the need for manual input.

The "Get campaign name" section allows users to retrieve the name of a specific campaign by providing the campaign ID. This feature is helpful for accessing campaign details and integrating them into external systems or applications. By utilizing this functionality, users can easily access and display campaign names without the need for manual input.

Your campaign's id - you can get it from the list endpoint or the url when you have the campaign opened in the app.

campaign_id

campaign_name

This section allows users to retrieve the status of a specific campaign using its ID. By accessing this information, users can track the progress and performance of their campaigns without the need to navigate through multiple screens or interfaces. This feature streamlines the monitoring process and provides quick access to essential campaign status data.

This section allows users to retrieve the status of a specific campaign using its ID. By accessing this information, users can track the progress and performance of their campaigns without the need to navigate through multiple screens or interfaces. This feature streamlines the monitoring process and provides quick access to essential campaign status data.

status

This section allows users to set a new name for their campaign. By providing the campaign ID and the desired name, users can easily update the name of their campaign. This feature simplifies the process of managing and organizing campaigns within the platform.

This section allows users to set a new name for their campaign. By providing the campaign ID and the desired name, users can easily update the name of their campaign. This feature simplifies the process of managing and organizing campaigns within the platform.

name

Get the list of sending accounts associated with a campaign

Get the list of sending accounts associated with a campaign

<div data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div >This endpoint sets the campaign&apos;s sending accounts to emails in the <code class="slate-code">account_list</code>. To add or remove a single sending account, skip to the next section.</div></div>

account_list

This endpoint helps add a single sending account to the specified campaign.

This endpoint helps add a single sending account to the specified campaign.

email

This endpoint helps remove a single sending account from the specified campaign.

This endpoint helps remove a single sending account from the specified campaign.

This endpoint helps you set one or more schedules for your campaign.<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 >Need help? Feel free to reach support through the in-app chat 🙂</div></div>

This endpoint helps you set one or more schedules for your campaign.

start_date

end_date

schedules

The Launch campaign section allows users to initiate the launch of a campaign within the system. By providing the necessary parameters, such as the API key and campaign ID, users can trigger the campaign launch process seamlessly. The response will indicate the status of the launch operation, ensuring visibility and clarity on the campaign&apos;s progress.

The Launch campaign section allows users to initiate the launch of a campaign within the system. By providing the necessary parameters, such as the API key and campaign ID, users can trigger the campaign launch process seamlessly. The response will indicate the status of the launch operation, ensuring visibility and clarity on the campaign's progress.

The &quot;Pause campaign&quot; section allows users to temporarily halt a specific campaign within their account. By pausing a campaign, users can prevent it from being actively displayed or executed, providing control and flexibility in managing their marketing efforts. This functionality helps users optimize their campaigns by allowing them to make adjustments or assess performance before resuming activity.

The "Pause campaign" section allows users to temporarily halt a specific campaign within their account. By pausing a campaign, users can prevent it from being actively displayed or executed, providing control and flexibility in managing their marketing efforts. This functionality helps users optimize their campaigns by allowing them to make adjustments or assess performance before resuming activity.

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.

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.