Campaign

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

Campaign

A campaign that can be sent to a list of recipients

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019a078d-23b3-7144-a9d4-02767aa1ba69"
namestringrequired

Name of the campaign

Example: "My First Campaign"
statusnumberread-onlyrequired

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_scheduleobjectrequired

Campaign schedule

campaign_schedule.​schedulesArray of objectsnon-emptyrequired
campaign_schedule.​schedules[].​namestringrequired
Example: "My Schedule"
campaign_schedule.​schedules[].​timingobjectrequired
campaign_schedule.​schedules[].​timing.​fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "09:00"
campaign_schedule.​schedules[].​timing.​tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "17:00"
campaign_schedule.​schedules[].​daysobjectnon-emptyrequired
campaign_schedule.​schedules[].​days.​0boolean
Example: true
campaign_schedule.​schedules[].​days.​1boolean
Example: true
campaign_schedule.​schedules[].​days.​2boolean
Example: true
campaign_schedule.​schedules[].​days.​3boolean
Example: true
campaign_schedule.​schedules[].​days.​4boolean
Example: true
campaign_schedule.​schedules[].​days.​5boolean
Example: false
campaign_schedule.​schedules[].​days.​6boolean
Example: false
campaign_schedule.​schedules[].​timezonestringrequired
Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"
Example: "Etc/GMT+12"
campaign_schedule.​start_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-10-21T16:14:41.587Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-10-21T16:14:41.587Z"
pl_valuenull or number

Value of every positive lead

Example: 100
is_evergreennull or boolean

Whether the campaign is evergreen

Example: false
sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

email_gapnull or number

The gap between emails in minutes

Example: 10
random_wait_maxnull or number

The maximum random wait time in minutes

Example: 10
text_onlynull or boolean

Whether the campaign is text only

Example: false
first_email_text_onlynull or boolean

Whether the campaign is send the first email as a text only

Example: false
email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]
daily_limitnull or number

The daily limit for sending emails

Example: 100
stop_on_replynull or boolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["019a078d-23b3-7144-a9d4-0277bbaba0a6"]
link_trackingnull or boolean

Whether to track links in emails

Example: true
open_trackingnull or boolean

Whether to track opens in emails

Example: true
stop_on_auto_replynull or boolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnull or number

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsnull or boolean

Whether to prioritize new leads

Example: false
auto_variant_selectnull or object

Auto variant select settings

match_lead_espnull or boolean

Whether to match leads by ESP

Example: false
stop_for_companynull or boolean

Whether to stop the campaign for the entire company(domain) when a lead replies

Example: false
insert_unsubscribe_headernull or boolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsnull or boolean

Whether to allow risky contacts

Example: false
disable_bounce_protectnull or boolean

Whether to disable bounce protection

Example: false
limit_emails_per_company_overridenull or object

Overrides the workspace-wide limit emails per company setting for this campaign.

cc_listArray of strings(email)

List of accounts to CC on emails

Example: ["john@doe.com"]
bcc_listArray of strings(email)

List of accounts to BCC on emails

Example: ["john@doe.com"]
organizationnull or string(uuid)read-only

Organization ID

Example: "019a078d-23b3-7144-a9d4-0278411b2c29"
owned_bynull or string(uuid)

Owner ID

Example: "019a078d-23b3-7144-a9d4-027957a280a2"
provider_routing_rulesArray of objects

Auto variant select settings

{
  "id": "019a078d-23b3-7144-a9d4-02767aa1ba69",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-10-21T16:14:41.587Z",
    "end_date": "2025-10-21T16:14:41.587Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-10-21T16:14:41.587Z",
  "timestamp_updated": "2025-10-21T16:14:41.587Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "first_email_text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "019a078d-23b3-7144-a9d4-0277bbaba0a6"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": null,
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "limit_emails_per_company_override": null,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019a078d-23b3-7144-a9d4-0278411b2c29",
  "owned_by": "019a078d-23b3-7144-a9d4-027957a280a2",
  "provider_routing_rules": [
    { … }
  ]
}

Create campaign

Request

Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all

Bodyapplication/jsonrequired

The Campaign to create

namestringrequired

Name of the campaign

Example: "My First Campaign"
campaign_scheduleobjectrequired

Campaign schedule

campaign_schedule.​schedulesArray of objectsnon-emptyrequired
campaign_schedule.​schedules[].​namestringrequired
Example: "My Schedule"
campaign_schedule.​schedules[].​timingobjectrequired
campaign_schedule.​schedules[].​timing.​fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "09:00"
campaign_schedule.​schedules[].​timing.​tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "17:00"
campaign_schedule.​schedules[].​daysobjectnon-emptyrequired
campaign_schedule.​schedules[].​days.​0boolean
Example: true
campaign_schedule.​schedules[].​days.​1boolean
Example: true
campaign_schedule.​schedules[].​days.​2boolean
Example: true
campaign_schedule.​schedules[].​days.​3boolean
Example: true
campaign_schedule.​schedules[].​days.​4boolean
Example: true
campaign_schedule.​schedules[].​days.​5boolean
Example: false
campaign_schedule.​schedules[].​days.​6boolean
Example: false
campaign_schedule.​schedules[].​timezonestringrequired
Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"
Example: "Etc/GMT+12"
campaign_schedule.​start_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
pl_valuenumber or null

Value of every positive lead

Example: 100
is_evergreenboolean or null

Whether the campaign is evergreen

Example: false
sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

email_gapnumber or null

The gap between emails in minutes

Example: 10
random_wait_maxnumber or null

The maximum random wait time in minutes

Example: 10
text_onlyboolean or null

Whether the campaign is text only

Example: false
first_email_text_onlyboolean or null

Whether the campaign is send the first email as a text only

Example: false
email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]
daily_limitnumber or null

The daily limit for sending emails

Example: 100
stop_on_replyboolean or null

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["019a078d-23b3-7144-a9d4-0277bbaba0a6"]
link_trackingboolean or null

Whether to track links in emails

Example: true
open_trackingboolean or null

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean or null

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber or null

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean or null

Whether to prioritize new leads

Example: false
auto_variant_selectobject or null

Auto variant select settings

match_lead_espboolean or null

Whether to match leads by ESP

Example: false
stop_for_companyboolean or null

Whether to stop the campaign for the entire company(domain) when a lead replies

Example: false
insert_unsubscribe_headerboolean or null

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean or null

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean or null

Whether to disable bounce protection

Example: false
limit_emails_per_company_overrideobject or null

Overrides the workspace-wide limit emails per company setting for this campaign.

cc_listArray of strings(email)

List of accounts to CC on emails

Example: ["john@doe.com"]
bcc_listArray of strings(email)

List of accounts to BCC on emails

Example: ["john@doe.com"]
owned_bystring or null(uuid)

Owner ID

Example: "019a078d-23b3-7144-a9d4-027957a280a2"
provider_routing_rulesArray of objects

Auto variant select settings

curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "My First Campaign",
    "campaign_schedule": {
      "schedules": [
        {
          "name": "My Schedule",
          "timing": {
            "from": "09:00",
            "to": "17:00"
          },
          "days": {},
          "timezone": "Etc/GMT+12"
        }
      ]
    }
  }'

Responses

The Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019a078d-23b3-7144-a9d4-02767aa1ba69"
namestringrequired

Name of the campaign

Example: "My First Campaign"
statusnumberread-onlyrequired

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_scheduleobjectrequired

Campaign schedule

campaign_schedule.​schedulesArray of objectsnon-emptyrequired
campaign_schedule.​schedules[].​namestringrequired
Example: "My Schedule"
campaign_schedule.​schedules[].​timingobjectrequired
campaign_schedule.​schedules[].​timing.​fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "09:00"
campaign_schedule.​schedules[].​timing.​tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "17:00"
campaign_schedule.​schedules[].​daysobjectnon-emptyrequired
campaign_schedule.​schedules[].​days.​0boolean
Example: true
campaign_schedule.​schedules[].​days.​1boolean
Example: true
campaign_schedule.​schedules[].​days.​2boolean
Example: true
campaign_schedule.​schedules[].​days.​3boolean
Example: true
campaign_schedule.​schedules[].​days.​4boolean
Example: true
campaign_schedule.​schedules[].​days.​5boolean
Example: false
campaign_schedule.​schedules[].​days.​6boolean
Example: false
campaign_schedule.​schedules[].​timezonestringrequired
Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"
Example: "Etc/GMT+12"
campaign_schedule.​start_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-10-21T16:14:41.587Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-10-21T16:14:41.587Z"
pl_valuenull or number

Value of every positive lead

Example: 100
is_evergreennull or boolean

Whether the campaign is evergreen

Example: false
sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

email_gapnull or number

The gap between emails in minutes

Example: 10
random_wait_maxnull or number

The maximum random wait time in minutes

Example: 10
text_onlynull or boolean

Whether the campaign is text only

Example: false
first_email_text_onlynull or boolean

Whether the campaign is send the first email as a text only

Example: false
email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]
daily_limitnull or number

The daily limit for sending emails

Example: 100
stop_on_replynull or boolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["019a078d-23b3-7144-a9d4-0277bbaba0a6"]
link_trackingnull or boolean

Whether to track links in emails

Example: true
open_trackingnull or boolean

Whether to track opens in emails

Example: true
stop_on_auto_replynull or boolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnull or number

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsnull or boolean

Whether to prioritize new leads

Example: false
auto_variant_selectnull or object

Auto variant select settings

match_lead_espnull or boolean

Whether to match leads by ESP

Example: false
stop_for_companynull or boolean

Whether to stop the campaign for the entire company(domain) when a lead replies

Example: false
insert_unsubscribe_headernull or boolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsnull or boolean

Whether to allow risky contacts

Example: false
disable_bounce_protectnull or boolean

Whether to disable bounce protection

Example: false
limit_emails_per_company_overridenull or object

Overrides the workspace-wide limit emails per company setting for this campaign.

cc_listArray of strings(email)

List of accounts to CC on emails

Example: ["john@doe.com"]
bcc_listArray of strings(email)

List of accounts to BCC on emails

Example: ["john@doe.com"]
organizationnull or string(uuid)read-only

Organization ID

Example: "019a078d-23b3-7144-a9d4-0278411b2c29"
owned_bynull or string(uuid)

Owner ID

Example: "019a078d-23b3-7144-a9d4-027957a280a2"
provider_routing_rulesArray of objects

Auto variant select settings

Response
application/json
{
  "id": "019a078d-23b3-7144-a9d4-02767aa1ba69",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-10-21T16:14:41.587Z",
    "end_date": "2025-10-21T16:14:41.587Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-10-21T16:14:41.587Z",
  "timestamp_updated": "2025-10-21T16:14:41.587Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "first_email_text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "019a078d-23b3-7144-a9d4-0277bbaba0a6"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": null,
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "limit_emails_per_company_override": null,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019a078d-23b3-7144-a9d4-0278411b2c29",
  "owned_by": "019a078d-23b3-7144-a9d4-027957a280a2",
  "provider_routing_rules": [
    { … }
  ]
}

List campaign

Request

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

Query
limitinteger[ 1 .. 100 ]

The number of items to return

Example: limit=10
starting_afterstring

The ID of the last item in the previous page - used for pagination. You can use the value of the next_starting_after field from the previous response.

Example: starting_after=01956fbd-0eb1-72db-a565-82977a586084
searchstring

Search by campaign name

Example: search=Summer Sale Campaign
tag_idsstring

Filter campaigns by tag ids. Returns campaigns that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.

Example: tag_ids=019a078d-34f3-7cc7-927e-ec32360fd97d,019a078d-34f3-7cc7-927e-ec334a617cbf
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns?limit=10&search=Summer%20Sale%20Campaign&starting_after=01956fbd-0eb1-72db-a565-82977a586084&tag_ids=019a078d-34f3-7cc7-927e-ec32360fd97d%2C019a078d-34f3-7cc7-927e-ec334a617cbf' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Campaign

Bodyapplication/json
itemsArray of objects(Campaign)required

The list of Campaign

items[].​idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019a078d-23b3-7144-a9d4-02767aa1ba69"
items[].​namestringrequired

Name of the campaign

Example: "My First Campaign"
items[].​statusnumberread-onlyrequired

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
items[].​campaign_scheduleobjectrequired

Campaign schedule

items[].​campaign_schedule.​schedulesArray of objectsnon-emptyrequired
items[].​campaign_schedule.​schedules[].​namestringrequired
Example: "My Schedule"
items[].​campaign_schedule.​schedules[].​timingobjectrequired
items[].​campaign_schedule.​schedules[].​timing.​fromstring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "09:00"
items[].​campaign_schedule.​schedules[].​timing.​tostring^([01][0-9]|2[0-3]):([0-5][0-9])$required
Example: "17:00"
items[].​campaign_schedule.​schedules[].​daysobjectnon-emptyrequired
items[].​campaign_schedule.​schedules[].​days.​0boolean
Example: true
items[].​campaign_schedule.​schedules[].​days.​1boolean
Example: true
items[].​campaign_schedule.​schedules[].​days.​2boolean
Example: true
items[].​campaign_schedule.​schedules[].​days.​3boolean
Example: true
items[].​campaign_schedule.​schedules[].​days.​4boolean
Example: true
items[].​campaign_schedule.​schedules[].​days.​5boolean
Example: false
items[].​campaign_schedule.​schedules[].​days.​6boolean
Example: false
items[].​campaign_schedule.​schedules[].​timezonestringrequired
Enum"Etc/GMT+12""Etc/GMT+11""Etc/GMT+10""America/Anchorage""America/Dawson""America/Creston""America/Chihuahua""America/Boise""America/Belize""America/Chicago"
Example: "Etc/GMT+12"
items[].​campaign_schedule.​start_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
items[].​campaign_schedule.​end_datestring(date-time)
Example: "2025-10-21T16:14:41.587Z"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-10-21T16:14:41.587Z"
items[].​timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-10-21T16:14:41.587Z"
items[].​pl_valuenull or number

Value of every positive lead

Example: 100
items[].​is_evergreennull or boolean

Whether the campaign is evergreen

Example: false
items[].​sequencesArray of objects

List of sequences (the actual email copy). Even though this field is an array, only the first element is used, so please provide only one array item, and add the steps to that array

items[].​email_gapnull or number

The gap between emails in minutes

Example: 10
items[].​random_wait_maxnull or number

The maximum random wait time in minutes

Example: 10
items[].​text_onlynull or boolean

Whether the campaign is text only

Example: false
items[].​first_email_text_onlynull or boolean

Whether the campaign is send the first email as a text only

Example: false
items[].​email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]
items[].​daily_limitnull or number

The daily limit for sending emails

Example: 100
items[].​stop_on_replynull or boolean

Whether to stop the campaign on reply

Example: false
items[].​email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["019a078d-23b3-7144-a9d4-0277bbaba0a6"]
items[].​link_trackingnull or boolean

Whether to track links in emails

Example: true
items[].​open_trackingnull or boolean

Whether to track opens in emails

Example: true
items[].​stop_on_auto_replynull or boolean

Whether to stop the campaign on auto reply

Example: false
items[].​daily_max_leadsnull or number

The daily maximum new leads to contact

Example: 100
items[].​prioritize_new_leadsnull or boolean

Whether to prioritize new leads

Example: false
items[].​auto_variant_selectnull or object

Auto variant select settings

items[].​match_lead_espnull or boolean

Whether to match leads by ESP

Example: false
items[].​stop_for_companynull or boolean

Whether to stop the campaign for the entire company(domain) when a lead replies

Example: false
items[].​insert_unsubscribe_headernull or boolean

Whether to insert an unsubscribe header in emails

Example: false
items[].​allow_risky_contactsnull or boolean

Whether to allow risky contacts

Example: false
items[].​disable_bounce_protectnull or boolean

Whether to disable bounce protection

Example: false
items[].​limit_emails_per_company_overridenull or object

Overrides the workspace-wide limit emails per company setting for this campaign.

items[].​cc_listArray of strings(email)

List of accounts to CC on emails

Example: ["john@doe.com"]
items[].​bcc_listArray of strings(email)

List of accounts to BCC on emails

Example: ["john@doe.com"]
items[].​organizationnull or string(uuid)read-only

Organization ID

Example: "019a078d-23b3-7144-a9d4-0278411b2c29"
items[].​owned_bynull or string(uuid)

Owner ID

Example: "019a078d-23b3-7144-a9d4-027957a280a2"
items[].​provider_routing_rulesArray of objects

Auto variant select settings

next_starting_afterstring

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

Example: "019a078d-34f3-7cc7-927e-ec34301beaeb"
Response
application/json
{
  "items": [
    { … }
  ],
  "next_starting_after": "019a078d-34f3-7cc7-927e-ec34301beaeb"
}

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

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

Schemas