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.

Endpoints

POST
POST

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
Was this section helpful?

What made this section unhelpful for you?

Endpoints

POST
GET
Was this section helpful?

What made this section unhelpful for you?

Verify single email

This endpoint helps verify a single email address.

If an email takes longer than 10 seconds to verify, the endpoint will return the status as “pending”. In that case, you may use the /verify/single/status to check the status of the verification job.

Alternatively, you can send a webhook_url to receive the results instead of polling the status endpoint.

Query Parameters

api_keystring Required

Your API key

Body Parameters

emailstring

The email address to verify

webhook_urlstring

Optional webhook url to receive results on

Response

200
Object

Response Attributes

statusstring Required

Verification status

Enum values:
success
indicates the verification job is finished and the final verification result is returned.
pending
indicates that the email is pending verification and that you should check the status in a few minutes
emailstring Required

The email address submitted for this verification

verification_statusstring Required

Result

Enum values:
valid
The email is valid and safe to send emails to
invalid
The email is invalid, or is risky to send emails to
catch_allboolean Required

Whether this email is in a catch_all domain or not

creditsnumber Required

Your verification credit balance

credits_usednumber Required

Credits used for this verification

Was this section helpful?

What made this section unhelpful for you?

Language Box

POST

/v1/verify/single?api_key=API_KEY

Select
1 2 3 4 5 curl --location 'https://api.instantly.ai/api/v1/verify/single?api_key=API_KEY' \ --data-raw '{ "email": "example@example.com", "webhook_url": "https://example.com" }'

Response

{
  "status": "success",
  "email": "example@example.com",
  "verification_status": "invalid",
  "catch_all": false,
  "credits": 1071394,
  "credits_used": 1
}
Was this section helpful?

What made this section unhelpful for you?

Get single email verification result

Get the verification result for single email verification.

This endpoint can be used if the /verify/single endpoint takes longer to verify emails, which can happen for certain tricky emails/domains. The result will be available for one day after verification.

Alternatively, you can send a webhook_url to the /verify/single endpoint to receive the results instead of polling the /status endpoint.

Query Parameters

api_keystring Required

Your API key

emailstring Required

The email for which you want to check the verification result

Response

200
Object

Response Attributes

statusstring Required

Verification status

Enum values:
success
indicates the verification job is finished and the final verification result is returned.
pending
indicates that the email is pending verification and that you should check the status in a few minutes
emailstring Required

The email address submitted for this verification

verification_statusstring Required

Result

Enum values:
valid
The email is valid and safe to send emails to
invalid
The email is invalid, or is risky to send emails to
catch_allboolean Required

Whether this email is in a catch_all domain or not

Was this section helpful?

What made this section unhelpful for you?

Language Box

GET

/v1/verify/single/status?api_key=API_KEY&email=example@example.com

Select
1 curl --location 'https://api.instantly.ai/api/v1/verify/single/status?api_key=API_KEY&email=example%40example.com' \

Response

{
  "status": "success",
  "email": "example@example.com",
  "verification_status": "invalid",
  "catch_all": false
}
Was this section helpful?

What made this section unhelpful for you?

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