Introduction
Welcome to Instantly. Let’s get started with getting you authenticated and ready to build! 🛠️
Finding your API key 🗝️
What made this section unhelpful for you?
What made this section unhelpful for you?
Test your API key
Once you have your API key, send a GET request to ensure everything is ready.
Query Parameters
The API key used to authenticate the request and access the specified workspace.
Response
Response Attributes
The name of the workspace associated with the authenticated API key.
What made this section unhelpful for you?
Response
{
"workspace_name": "Name of your workspace"
}
What made this section unhelpful for you?
Rate limits
Our platform allows a maximum of 10 requests per second to prevent abuse.
Going above this limit will return an error for all request types (POST
/ GET
)
429
What made this section unhelpful for you?
Response
What made this section unhelpful for you?
Campaign
The campaign endpoints allow you to interact with individual email campaigns, update their options, sending accounts, and status. See below for details.
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.
Base URL
Production:
https://api.instantly.ai/api
Lead
The lead endpoints allow you to interact with lead data in your workspace.
Endpoints
POST
GET
POST
POST
POST
POST
POST
Blocklist
The blocklist endpoints allow you to interact with your campaign blocklist. See below for details.
Endpoints
POST
POST
Account
The account endpoints allow you to interact with your sending accounts. See below for details.
Endpoints
GET
POST
GET
POST
POST
POST
POST
Unibox
The account endpoints allow you to interact with the Instantly Unibox. See below for details.
Endpoints
GET
GET
POST
POST
Tags
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
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.
- Submitting a verification job
- 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