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: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
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: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

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
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns?limit=10&search=Summer%20Sale%20Campaign&starting_after=01956fbd-0eb1-72db-a565-82977a586084' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The list of Campaign

Bodyapplication/json
itemsArray of objects(Campaign)required
items[].​idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
items[].​campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
items[].​timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
items[].​timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
items[].​pl_valuenumber

Value of every positive lead

Example: 100
items[].​is_evergreenboolean

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_gapnumber

The gap between emails in minutes

Example: 10
items[].​random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
items[].​text_onlyboolean

Whether the campaign is text only

Example: false
items[].​email_listArray of strings

List of accounts to use for sending emails

Example: ["john@doe.com"]
items[].​daily_limitnumber

The daily limit for sending emails

Example: 100
items[].​stop_on_replyboolean

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: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
items[].​link_trackingboolean

Whether to track links in emails

Example: true
items[].​open_trackingboolean

Whether to track opens in emails

Example: true
items[].​stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
items[].​daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
items[].​prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
items[].​auto_variant_selectobject

Auto variant select settings

items[].​match_lead_espboolean

Whether to match leads by ESP

Example: false
items[].​stop_for_companyboolean

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

Example: false
items[].​insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
items[].​allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
items[].​disable_bounce_protectboolean

Whether to disable bounce protection

Example: false
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[].​organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
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: "01967bad-d04a-7e84-aab3-5496cae04361"
Response
application/json
{ "items": [ { … } ], "next_starting_after": "01967bad-d04a-7e84-aab3-5496cae04361" }

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: 01967bad-d049-70d7-bf7a-87a75a1667fa
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d049-70d7-bf7a-87a75a1667fa/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

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: 01967bad-d049-70d7-bf7a-87a8e8cae43b
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d049-70d7-bf7a-87a8e8cae43b/pause \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

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: 01967bad-d04a-7e84-aab3-54953bb0bc94
curl -i -X GET \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d04a-7e84-aab3-54953bb0bc94 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

Patch campaign

Request

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

Path
idstring(uuid)required

The ID of the item to update

Example: 01967bad-d04d-76ed-82e9-8e0b8faa7b2e
Bodyapplication/json
non-empty
namestring

Name of the campaign

Example: "My First Campaign"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

Whether the campaign is evergreen

Example: false
campaign_scheduleobject

Campaign schedule

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
curl -i -X PATCH \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d04d-76ed-82e9-8e0b8faa7b2e \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

The updated Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

Delete campaign

Request

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

Path
idstring(uuid)required

The ID of the item to delete

Example: 01967bad-d04d-76ed-82e9-8e0c914d03cb
Bodyapplication/json
null
curl -i -X DELETE \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d04d-76ed-82e9-8e0c914d03cb \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json'

Responses

The deleted Campaign

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01967bad-c603-7fdf-9283-58ee50830572"
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-04-28T09:15:08.163Z"
campaign_schedule.​end_datestring(date-time)
Example: "2025-04-28T09:15:08.163Z"
timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-04-28T09:15:08.163Z"
timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-04-28T09:15:08.163Z"
pl_valuenumber

Value of every positive lead

Example: 100
is_evergreenboolean

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

The gap between emails in minutes

Example: 10
random_wait_maxnumber

The maximum random wait time in minutes

Example: 10
text_onlyboolean

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_limitnumber

The daily limit for sending emails

Example: 100
stop_on_replyboolean

Whether to stop the campaign on reply

Example: false
email_tag_listArray of strings(uuid)

List of tags to use for sending emails

Example: ["01967bad-c603-7fdf-9283-58ef943aa7ed"]
link_trackingboolean

Whether to track links in emails

Example: true
open_trackingboolean

Whether to track opens in emails

Example: true
stop_on_auto_replyboolean

Whether to stop the campaign on auto reply

Example: false
daily_max_leadsnumber

The daily maximum new leads to contact

Example: 100
prioritize_new_leadsboolean

Whether to prioritize new leads

Example: false
auto_variant_selectobject

Auto variant select settings

match_lead_espboolean

Whether to match leads by ESP

Example: false
stop_for_companyboolean

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

Example: false
insert_unsubscribe_headerboolean

Whether to insert an unsubscribe header in emails

Example: false
allow_risky_contactsboolean

Whether to allow risky contacts

Example: false
disable_bounce_protectboolean

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"]
organizationstring(uuid)read-only

Organization ID

Example: "01967bad-c603-7fdf-9283-58f0d06bf858"
Response
application/json
{ "id": "01967bad-c603-7fdf-9283-58ee50830572", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-04-28T09:15:08.163Z", "end_date": "2025-04-28T09:15:08.163Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-04-28T09:15:08.163Z", "timestamp_updated": "2025-04-28T09:15:08.163Z", "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": [ "01967bad-c603-7fdf-9283-58ef943aa7ed" ], "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": "01967bad-c603-7fdf-9283-58f0d06bf858" }

Get campaign(s) analytics

Request

Get analytics for one or multiple campaigns. Specify the id field to get the analytics for a single campaign, or leave it empty to get the analytics for all campaigns

Query
idstring(uuid)

A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns

Example: id=01967bad-d04b-7003-a776-9752c5095a62
idsArray of strings(uuid)
Example: ids=01967bad-d04b-7003-a776-9753b1013701
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
exclude_total_leads_countboolean

Exclude the total leads from the result. Setting this to true will considerably decrease the response time

Default false
Example: exclude_total_leads_count=true
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics?end_date=2024-01-01&exclude_total_leads_count=true&id=01967bad-d04b-7003-a776-9752c5095a62&ids=01967bad-d04b-7003-a776-9753b1013701&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
campaign_namestringrequired

The name of the campaign

Example: "My Test Campaign"
campaign_idstring(uuid)required

The ID of the campaign

Example: "01967bad-d04b-7003-a776-97541ec8f7e3"
campaign_statusnumberrequired

The 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_is_evergreenbooleanrequired

Whether the campaign is evergreen

Example: true
leads_countintegerrequired

The total number of leads

Example: 1500
contacted_countintegerrequired

Number of leads for whom the sequence has started

Example: 1200
open_countintegerrequired

The number of leads that opened at least one email

Example: 800
reply_countintegerrequired

The number of leads that replied to at least one email

Example: 300
link_click_countintegerrequired

The number of links that got clicked

Example: 800
bounced_countintegerrequired

The number of bounced leads

Example: 50
unsubscribed_countintegerrequired

The number of unsubscribed leads

Example: 20
completed_countintegerrequired

The number of leads that the campaign was completed for

Example: 1100
emails_sent_countintegerrequired

The total number of sent emails

Example: 5000
new_leads_contacted_countintegerrequired

The total number of new leads contacted

Example: 200
total_opportunitiesintegerrequired

The total number of unique opportunities created

Example: 10
total_opportunity_valuenumberrequired

The total value of opportunities created

Example: 1000
]
Response
application/json
[ { "campaign_name": "My Test Campaign", "campaign_id": "01967bad-d04b-7003-a776-97541ec8f7e3", "campaign_status": 1, "campaign_is_evergreen": true, "leads_count": 1500, "contacted_count": 1200, "open_count": 800, "reply_count": 300, "link_click_count": 800, "bounced_count": 50, "unsubscribed_count": 20, "completed_count": 1100, "emails_sent_count": 5000, "new_leads_contacted_count": 200, "total_opportunities": 10, "total_opportunity_value": 1000 } ]

Get campaign(s) analytics overview

Request

Get analytics overview for one or multiple campaigns. Specify the id field to get the analytics overview for a single campaign, or leave it empty to get the analytics overview for all campaigns

Query
idstring(uuid)

A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns

Example: id=01967bad-d04b-7003-a776-9755445a0e00
idsArray of strings(uuid)
Example: ids=01967bad-d04b-7003-a776-9756af0e198c
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
campaign_statusnumber

Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)

Enum ValueDescription
0

Draft

1

Active

2

Paused

3

Completed

4

Running Subsequences

-99

Account Suspended

-1

Accounts Unhealthy

-2

Bounce Protect

Example: campaign_status=1
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/overview?campaign_status=1&end_date=2024-01-01&id=01967bad-d04b-7003-a776-9755445a0e00&ids=01967bad-d04b-7003-a776-9756af0e198c&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
open_countinteger

The total number of times the emails were opened, including duplicates

Example: 800
open_count_uniqueinteger

The number of emails that got opened (for the first time only)

Example: 800
open_count_unique_by_stepinteger

The unique number of times the emails were opened (counted once per lead, step, and campaign)

Example: 800
link_click_countinteger

The number of links that got clicked

Example: 800
link_click_count_uniqueinteger

The number of links that got clicked (for the first time)

Example: 800
link_click_count_unique_by_stepinteger

The unique number of links that got clicked, per step (counted once per lead, step, and campaign)

Example: 800
reply_countinteger

The number of leads that replied to at least one email

Example: 300
reply_count_uniqueinteger

The number of leads that replied to at least one email (for the first time only)

Example: 300
reply_count_unique_by_stepinteger

The unique number of leads that replied to at least one email, per step (counted once per lead, step, and campaign)

Example: 300
bounced_countinteger

The number of bounced leads

Example: 50
unsubscribed_countinteger

The number of unsubscribed leads

Example: 20
completed_countinteger

The number of leads that the campaign was completed for

Example: 1100
emails_sent_countinteger

The total number of sent emails

Example: 5000
new_leads_contacted_countinteger

The total number of new leads contacted

Example: 200
total_opportunitiesinteger

The total number of unique opportunities created

Example: 10
total_opportunity_valuenumber

The total value of opportunities created

Example: 1000
total_interestedinteger

The total number of interested opportunities created

Example: 103
total_meeting_bookedinteger

The total number of meeting booked opportunities created

Example: 45
total_meeting_completedinteger

The total number of meeting completed opportunities created

Example: 12
total_closedinteger

The total number of closed opportunities created

Example: 10
Response
application/json
{ "open_count": 800, "open_count_unique": 800, "open_count_unique_by_step": 800, "link_click_count": 800, "link_click_count_unique": 800, "link_click_count_unique_by_step": 800, "reply_count": 300, "reply_count_unique": 300, "reply_count_unique_by_step": 300, "bounced_count": 50, "unsubscribed_count": 20, "completed_count": 1100, "emails_sent_count": 5000, "new_leads_contacted_count": 200, "total_opportunities": 10, "total_opportunity_value": 1000, "total_interested": 103, "total_meeting_booked": 45, "total_meeting_completed": 12, "total_closed": 10 }

Get daily campaign analytics

Request

Get campaign daily analytics

Query
campaign_idstring(uuid)

Campaign ID (optional). Leave this field empty to get the analytics for all campaigns

Example: campaign_id=01967bad-d04c-7143-983c-a97af5360dd4
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
campaign_statusnumber

Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)

Enum ValueDescription
0

Draft

1

Active

2

Paused

3

Completed

4

Running Subsequences

-99

Account Suspended

-1

Accounts Unhealthy

-2

Bounce Protect

Example: campaign_status=1
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign_id=01967bad-d04c-7143-983c-a97af5360dd4&campaign_status=1&end_date=2024-01-01&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
datestring

The date of the analytics entry, in YYYY-MM-DD format

Example: "2025-03-01"
sentinteger

The total number of sent emails

Example: 5421
openedinteger

The total number of opened emails

Example: 99
unique_openedinteger

The total number of unique opened emails

Example: 60
repliesinteger

The total number of replies

Example: 60
unique_repliesinteger

The total number of unique replies

Example: 60
clicksinteger

The total number of links clicked

Example: 60
unique_clicksinteger

The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click

Example: 60
]
Response
application/json
[ { "date": "2025-03-01", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60 } ]

Get campaign steps analytics

Request

Get campaign steps analytics

Query
campaign_idstring(uuid)

Campaign ID (optional). Leave this field empty to get the analytics for all campaigns

Example: campaign_id=01967bad-d04c-7143-983c-a97b1e8af876
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign_id=01967bad-d04c-7143-983c-a97b1e8af876&end_date=2024-01-01&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
stepstring

The step number

Example: "1"
variantstring

The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc.

Example: "0"
sentinteger

The total number of sent emails

Example: 5421
openedinteger

The total number of opened emails

Example: 99
unique_openedinteger

The total number of opened emails

Example: 60
repliesinteger

The total number of replies

Example: 60
unique_repliesinteger

The total number of replies

Example: 60
clicksinteger

The total number of links clicked

Example: 60
unique_clicksinteger

The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click

Example: 60
]
Response
application/json
[ { "step": "1", "variant": "0", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60 } ]

Share a campaign

Request

Share a campaign. This allows other users to create new campaigns based on this campaign. The campaign is being shared for 7 days, after which you'll have to call this endpoint again if you want to enable sharing on the campaign

Path
idstring(uuid)required

Campaign ID

Example: 01967bad-d04d-76ed-82e9-8e0d2d2e07d5
curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01967bad-d04d-76ed-82e9-8e0d2d2e07d5/share \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/json
any
Response
application/json
null

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 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

Audit Log

Audit log records for tracking system activities

Operations

Schemas