Account Campaign Mapping

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

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

Account Campaign Mapping

Account Campaign Mapping

campaign_idstring(uuid)required
Example: "01959271-1ba3-7369-a130-d1d978fb5797"
campaign_namestringrequired
Example: "Campaign Name"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:21.059Z"
statusnumber

Campaign Status

Enum ValueDescription
0

Draft

1

Active

2

Paused

3

Completed

4

Running Subsequences

-99

Account Suspended

-1

Accounts Unhealthy

-2

Bounce Protect

Example: 1
{
  "campaign_id": "01959271-1ba3-7369-a130-d1d978fb5797",
  "campaign_name": "Campaign Name",
  "timestamp_created": "2025-03-14T02:17:21.059Z",
  "status": 1
}

Get campaigns associated with an email

Request

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

Path
emailstringrequired

Email

Example: user@example.com
Query
limitnumber
Example: limit=10
starting_afterstring
Example: starting_after=2025-03-07T00:00:00.000Z
curl -i -X GET \
  'https://api.instantly.ai/api/v2/account-campaign-mappings/user@example.com?limit=10&starting_after=2025-03-07T00%3A00%3A00.000Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Account Campaign Mapping

Bodyapplication/json
itemsArray of objects(Account Campaign Mapping)required
items[].​campaign_idstring(uuid)required
Example: "01959271-1ba3-7369-a130-d1d978fb5797"
items[].​campaign_namestringrequired
Example: "Campaign Name"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:21.059Z"
items[].​statusnumber

Campaign Status

Enum ValueDescription
0

Draft

1

Active

2

Paused

3

Completed

4

Running Subsequences

-99

Account Suspended

-1

Accounts Unhealthy

-2

Bounce Protect

Example: 1
next_starting_afterstring

The filter for getting the next items after this one, this could either be a UUID, a MongoDB ID, a timestamp, on an email depending on the specific API

Example: "0000-0000-0000-0000"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

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 items

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

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

Schemas