API explorerChangelog
API explorer
Changelog

Theme switcher

Introduction

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Welcome to Instantly. Let’s get started with getting you authenticated and ready to build! πŸ› οΈ

Finding your API key πŸ—οΈ

1

Go to Instantly Dashboard

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

2

Go to Settings β†’ Integrations

To get to your API key, go to your: Instantly Dashboard β†’ Settings β†’ Integrations β†’ API

https://app.instantly.ai/app/settings/integrations

3

Retrieve your API key

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

You need to be on the Hypergrowth plan (or above) to be able to access the API key.

1 2 3 4 5 To get to your API key, go to your: Instantly Dashboard β†’ Settings β†’ Integrations β†’ API https: //app.instantly.ai/app/settings/integrations

Campaign

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Endpoints

GET
GET
GET
POST
GET
POST
POST
POST
POST
POST
POST

Analytics

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Base URL

Production:

https://api.instantly.ai/api

Lead

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Endpoints

POST
GET
POST
POST
POST
POST
POST

Blocklist

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Was this section helpful?

What made this section unhelpful for you?

Endpoints

POST
POST
Was this section helpful?

What made this section unhelpful for you?

Add entries to blocklist

The "Add entries to blocklist" section allows users to add email addresses or domains to a blocklist, preventing them from accessing certain services. With this functionality, users can effectively manage and control access to their platform by specifying which entries should be blocked. This action helps enhance security and streamline user management processes.

Body Parameters

api_keystring Required

Your API key

entriesarray Required

A list of email addresses or domains you want to block.

Show child attributes

Response

200
Object

Response Attributes

statusstring

Response status

entries_addednumber

Number of entries added to the blocklist

already_in_blocklistnumber

Number of entries that already existed in the blocklist

blocklist_idstring

ID of the blocklist used

Was this section helpful?

What made this section unhelpful for you?

Language Box

POST

/v1/blocklist/add/entries

Select
1 2 3 4 5 6 7 8 curl --location 'https://api.instantly.ai/api/v1/blocklist/add/entries' \ --data-raw '{ "api_key": "", "entries": [ "abc@xyz.com", "domain.com" ] }'

Response

{
  "status": "success",
  "entries_added": null,
  "already_in_blocklist": 2,
  "blocklist_id": ""
}
Was this section helpful?

What made this section unhelpful for you?

Remove entries from blocklist

This api allows users to remove specific entries from the blocklist associated with their API key. By utilizing this functionality, users can efficiently manage their blocklist by selectively deleting unwanted entries. This action helps maintain the accuracy and relevance of the blocklist for their API integration.

Body Parameters

api_keystring Required

Your API key

entriesarray

Specifies the entries to be removed from the blocklist.

Show child attributes

Response

200
Object

Response Attributes

statusstring

Indicates the status of the API request.

entries_deletednumber

Indicates the number of entries that were successfully deleted.

not_in_blocklistnumber

Indicates if the specified entries are not in the blocklist.

Was this section helpful?

What made this section unhelpful for you?

Language Box

POST

/v1/blocklist/delete/entries

Select
1 2 3 4 5 6 7 8 curl --location 'https://api.instantly.ai/api/v1/blocklist/delete/entries' \ --data-raw '{ "api_key": "", "entries": [ "abc@xyz.com", "domain.com" ] }'

Response

{
  "status": "success",
  "entries_deleted": 2,
  "not_in_blocklist": null
}
Was this section helpful?

What made this section unhelpful for you?

Account

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Endpoints

GET
POST
GET
POST
POST
POST
POST

Unibox

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

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Endpoints

GET
GET
POST
POST

Tags

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

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 Type and Resource ID: The resource type and resource ID are used to uniquely identify a specific resource.

  • Resource Type: 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 "account" for user accounts and "campaign" for marketing campaigns.
  • Resource ID: 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 account with an email address "johndoe@instantly.ai", the email address would be the resource ID for the "account" resource type.

Endpoints

POST
GET
GET
PATCH
DELETE
POST

Email Verification

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

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.

  1. Submitting a verification job
  2. Checking the status of a verification job

Endpoints

POST
GET

Custom Tracking Domain

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: https://help.instantly.ai/en/articles/6984188-custom-tracking-domain

Notice: This API (Version 1) has been deprecated. Please refer to the API v2 documentation for the latest version.

Endpoints

POST
GET
DELETE