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

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.

Was this section helpful?

What made this section unhelpful for you?

Endpoints

POST
GET
DELETE
Was this section helpful?

What made this section unhelpful for you?

Add a custom tracking domain

This endpoint helps add a new custom tracking domain for a specific sending account.

Please make sure you have updated the CNAME record for the host - read more here: https://help.instantly.ai/en/articles/6984188-custom-tracking-domain

Body Parameters

api_keystring Required

Your API key

emailstring Required

The email address to add the custom tracking domain for

hoststring Required

The tracking domain host

skip_cname_checkboolean

It is not recommended to set this to true. You may use this if you want to skip the CNAME check, which can be helpful if you do not want to wait for the DNS to propagate before making the API call.

Response

200
Object

Response Attributes

statusstring Required

API response status

Enum values:
success
indicates the verification job is finished and the final verification result is returned.
hoststring

The tracking domain host

emailstring

The email address for which the tracking domain was added

messagestring

Response message

Was this section helpful?

What made this section unhelpful for you?

Language Box

POST

/v1/ctd

Select
1 2 3 4 5 6 7 curl --location 'https://api.instantly.ai/api/v1/ctd' \ --data-raw '{ "api_key": "API_KEY", "email": "example@example.com", "host": "subdomain.yourdomain.com", "skip_cname_check": false }'

Response

{
  "status": "success",
  "host": "subdomain.yourdomain.com",
  "email": "example@example.com",
  "message": "Custom tracking domain added successfully"
}
Was this section helpful?

What made this section unhelpful for you?

Get status of tracking domain host

Get the current status of a tracking domain host.

This endpoint can be used to check whether the CNAME and SSL for a tracking domain are set up as expected.

Query Parameters

api_keystring Required

Your API key

hoststring

The tracking domain host for which you want to check status.

Response

200
Object

Response Attributes

successboolean

Whether the API was successful

sslboolean

Whether the SSL was found working correctly

cnameboolean

Whether the CNAME record is resolving correctly (this is setup on your end)

hoststring

The tracking domain host for which you are receiving this response.

Was this section helpful?

What made this section unhelpful for you?

Language Box

GET

/v1/ctd/host/status?api_key=API_KEY&host=subdomain.yourdomain.com

Select
1 curl --location 'https://api.instantly.ai/api/v1/ctd/host/status?api_key=API_KEY&host=subdomain.yourdomain.com' \

Response

{
  "success": true,
  "ssl": true,
  "cname": true,
  "host": "subdomain.yourdomain.com"
}
Was this section helpful?

What made this section unhelpful for you?

Remove tracking domain

This endpoint helps you remove a custom tracking domain for a specific sending account.

Body Parameters

api_keystring Required

Your API key

emailstring Required

The email address to remove a custom tracking domain for

Response

200
Object

Response Attributes

statusstring Required

API response status

Enum values:
success
indicates the verification job is finished and the final verification result is returned.
emailstring

The email address for which the tracking domain was added

messagestring

Response message

Was this section helpful?

What made this section unhelpful for you?

Language Box

DELETE

/v1/ctd

Select
1 2 3 4 5 curl --location --request DELETE 'https://api.instantly.ai/api/v1/ctd' \ --data-raw '{ "api_key": "API_KEY", "email": "example@example.com" }'

Response

{
  "status": "success",
  "email": "example@example.com",
  "message": "Custom tracking domain removed successfully"
}
Was this section helpful?

What made this section unhelpful for you?