Account
/
Test account vitals

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Get custom tracking domain status

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Query
hoststringrequired

Custom tracking domain host

Example: host=example.com
curl -i -X GET \
  'https://api.instantly.ai/api/v2/accounts/ctd/status?host=example.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
successboolean
Example: true
sslboolean
Example: true
cnameboolean
Example: true
hoststring
Example: "example.com"
Response
application/json
{
  "success": true,
  "ssl": true,
  "cname": true,
  "host": "example.com"
}

Test account vitals

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Bodyapplication/json
accountsArray of strings
Example: ["user@example.com"]
curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/test/vitals \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Default Response

Bodyapplication/json
statusstring
Example: "success"
success_listArray of objects
failure_listArray of objects
Response
application/json
{
  "status": "success",
  "success_list": [
    { … }
  ],
  "failure_list": [
    { … }
  ]
}

Move accounts between workspaces

Request

Move accounts between workspaces. IMPORTANT: this endpoint should be called ONLY with an ADMIN workspace API key (check the workspace group docs: https://developer.instantly.ai/workspace-group), and both the source and destination workspaces must have the same admin workspace.

Bodyapplication/jsonrequired
emailsArray of stringsnon-emptyrequired

Array of email addresses of the accounts to move

Example: ["user@example.com"]
source_workspace_idstringrequired

ID of the source workspace (the workspace that the accounts are currently in)

Example: "019b483f-9f81-7e73-b56e-8f7636907411"
destination_workspace_idstringrequired

ID of the destination workspace (the workspace that the accounts will be moved to)

Example: "019b483f-9f81-7e73-b56e-8f77deacf654"
curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/move \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": [
      "user@example.com"
    ],
    "source_workspace_id": "019b483f-9f81-7e73-b56e-8f7636907411",
    "destination_workspace_id": "019b483f-9f81-7e73-b56e-8f77deacf654"
  }'

Responses

Default Response

Bodyapplication/json
statusstring
ValueDescription
success

The accounts were moved successfully

Example: "success"
Response
application/json
{
  "status": "success"
}

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Custom Tag Mapping

This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Webhook Event

A webhook event that was sent or attempted to be sent

Operations

DFY Email Account Order

A Done-For-You email account order

Operations

Custom Prompt Template

Custom prompt templates for creating custom prompts

Sales Flow

Manages how sales users view and interact with campaign and lead lists within the sales flow.

Email Template

A campaign email template

Workspace Billing

Workspace Billing

Operations

CRM Actions

CRM related actions

Operations

Schemas