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.

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

https://api.instantly.ai/api

Was this section helpful?

What made this section unhelpful for you?

Get campaign summary

Get the lead status summary for a given campaign

Query Parameters

api_keystring Required
campaign_idstring Required

Response

200
Object

Response Attributes

campaign_idstring
campaign_namestring

Campaign's name

total_leadsnumber

Total number of leads

contactednumber

Number of leads for whom the sequence has started

leads_who_readnumber

Number of leads who have opened at least one email

leads_who_repliednumber

Number of leads who have replied

bouncednumber

Number of bounced leads

unsubscribednumber

Number of unsubscribed leads

completednumber

Number of leads for whom the sequence has completed

Was this section helpful?

What made this section unhelpful for you?

Language Box

GET

/v1/analytics/campaign/summary?api_key=API_KEY&campaign_id=00000000-0000-0000-0000-000000000000

Select
1 curl --location 'https://api.instantly.ai/api/v1/analytics/campaign/summary?api_key=API_KEY&campaign_id=00000000-0000-0000-0000-000000000000' \

Response

{
  "campaign_id": "00000000-0000-0000-0000-000000000000",
  "campaign_name": "My first campaign",
  "total_leads": 1,
  "contacted": 1,
  "leads_who_read": 1,
  "leads_who_replied": 1,
  "bounced": null,
  "unsubscribed": null,
  "completed": 1
}
Was this section helpful?

What made this section unhelpful for you?

Get campaign count

Get the actual data count for a campaign.

Given that this endpoint counts the actual occurrences, it will also consider the numbers for any deleted leads.

Query Parameters

api_keystring Required

Your API Key

campaign_idstring

Optional - campaign ID; if left blank, analytics data for all campaigns in the workspace will be returned.

start_datestring Required

Start date for analytics period

end_datestring

Optional - End date for analytics period

Response

200
Object

Response Attributes

campaign_idstring
campaign_namestring
total_emails_sentnumber
emails_readnumber
new_leads_contactednumber
leads_repliednumber
leads_readnumber
Was this section helpful?

What made this section unhelpful for you?

Language Box

GET

/v1/analytics/campaign/count?api_key=API_KEY&campaign_id=00000000-0000-0000-0000-000000000000&start_date=01-01-2023&end_date=01-31-2023

Select
1 curl --location 'https://api.instantly.ai/api/v1/analytics/campaign/count?api_key=API_KEY&campaign_id=00000000-0000-0000-0000-000000000000&start_date=01-01-2023&end_date=01-31-2023' \

Response

[
  {
    "campaign_id": "917dba2e-fb41-4f35-b8a5-1b068efe7573",
    "campaign_name": "Twitter:Crunchbase_Scrapybird_OurCopy",
    "total_emails_sent": null,
    "emails_read": 13,
    "new_leads_contacted": null,
    "leads_replied": 1,
    "leads_read": null
  },
  {
    "campaign_id": "a271a79f-bf6d-4854-8631-7536e93e80d1",
    "campaign_name": "Recruiting: USA_T1_Clutch/Findymail_Our Copy",
    "total_emails_sent": 1565,
    "emails_read": null,
    "new_leads_contacted": 422,
    "leads_replied": 38,
    "leads_read": null
  }
]
Was this section helpful?

What made this section unhelpful for you?

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.

Endpoints

POST
GET
DELETE