Campaign
/
Stop(or pause) a 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

Activate(start), or resume a campaign

Request

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

Path
idstring(uuid)required

Campaign ID

Example: 019942fb-7274-725e-8405-06c71b951d75
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/019942fb-7274-725e-8405-06c71b951d75/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019942fb-54a1-73dc-89a2-5f7483674a3d"
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-09-13T12:09:51.520Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-09-13T12:09:51.520Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-09-13T12:09:51.521Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-09-13T12:09:51.521Z"
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
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: ["019942fb-54a1-73dc-89a2-5f751b858434"]
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_selectobject

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
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: "019942fb-54a1-73dc-89a2-5f7657542db6"
Response
application/json
{
  "id": "019942fb-54a1-73dc-89a2-5f7483674a3d",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-09-13T12:09:51.520Z",
    "end_date": "2025-09-13T12:09:51.520Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-09-13T12:09:51.521Z",
  "timestamp_updated": "2025-09-13T12:09:51.521Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "019942fb-54a1-73dc-89a2-5f751b858434"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019942fb-54a1-73dc-89a2-5f7657542db6"
}

Stop(or pause) a campaign

Request

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

Path
idstring(uuid)required

Campaign ID

Example: 019942fb-7274-725e-8405-06c8252c7f24
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/019942fb-7274-725e-8405-06c8252c7f24/pause \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019942fb-54a1-73dc-89a2-5f7483674a3d"
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-09-13T12:09:51.520Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-09-13T12:09:51.520Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-09-13T12:09:51.521Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-09-13T12:09:51.521Z"
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
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: ["019942fb-54a1-73dc-89a2-5f751b858434"]
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_selectobject

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
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: "019942fb-54a1-73dc-89a2-5f7657542db6"
Response
application/json
{
  "id": "019942fb-54a1-73dc-89a2-5f7483674a3d",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-09-13T12:09:51.520Z",
    "end_date": "2025-09-13T12:09:51.520Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-09-13T12:09:51.521Z",
  "timestamp_updated": "2025-09-13T12:09:51.521Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "019942fb-54a1-73dc-89a2-5f751b858434"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019942fb-54a1-73dc-89a2-5f7657542db6"
}

Get campaign

Request

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

Path
idstring(uuid)required

The ID of the requested item

Example: 019942fb-7275-78aa-b4f8-5101ad7e07ab
curl -i -X GET \
  https://api.instantly.ai/api/v2/campaigns/019942fb-7275-78aa-b4f8-5101ad7e07ab \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "019942fb-54a1-73dc-89a2-5f7483674a3d"
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-09-13T12:09:51.520Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-09-13T12:09:51.520Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-09-13T12:09:51.521Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-09-13T12:09:51.521Z"
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
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: ["019942fb-54a1-73dc-89a2-5f751b858434"]
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_selectobject

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
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: "019942fb-54a1-73dc-89a2-5f7657542db6"
Response
application/json
{
  "id": "019942fb-54a1-73dc-89a2-5f7483674a3d",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-09-13T12:09:51.520Z",
    "end_date": "2025-09-13T12:09:51.520Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-09-13T12:09:51.521Z",
  "timestamp_updated": "2025-09-13T12:09:51.521Z",
  "email_gap": 10,
  "random_wait_max": 10,
  "text_only": false,
  "email_list": [
    "john@doe.com"
  ],
  "daily_limit": 100,
  "stop_on_reply": false,
  "email_tag_list": [
    "019942fb-54a1-73dc-89a2-5f751b858434"
  ],
  "link_tracking": true,
  "open_tracking": true,
  "stop_on_auto_reply": false,
  "daily_max_leads": 100,
  "prioritize_new_leads": false,
  "auto_variant_select": {
    "trigger": "click_rate"
  },
  "match_lead_esp": false,
  "stop_for_company": false,
  "insert_unsubscribe_header": false,
  "allow_risky_contacts": false,
  "disable_bounce_protect": false,
  "cc_list": [
    "john@doe.com"
  ],
  "bcc_list": [
    "john@doe.com"
  ],
  "organization": "019942fb-54a1-73dc-89a2-5f7657542db6"
}

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

A SuperSearch enrichment that retrieves and enriches leads based on search filters

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

Clause

A clause (filter or sort) that can be applied to variables in campaigns or lists

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

Schemas