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

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: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

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(uuid)

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: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

items[].namestringrequired

Name of the campaign

Example: "My First Campaign"

items[].statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

items[].campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

items[].timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

items[].timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

next_starting_afterstring

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

Example: "0000-0000-0000-0000"

Response

application/json

{
  "items": [
    { … }
  ],
  "next_starting_after": "0000-0000-0000-0000"
}

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: 01959271-2fa8-774e-b2bc-44643984c2b2

curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01959271-2fa8-774e-b2bc-44643984c2b2/activate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

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: 01959271-2fa8-774e-b2bc-4465a26b2092

curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01959271-2fa8-774e-b2bc-4465a26b2092/pause \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

Get campaign

Request

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

Path

idstringrequired

curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Campaign

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

Patch campaign

Request

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

Path

idstringrequired

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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/{id}' \
  -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: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

Delete campaign

Request

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

Path

idstringrequired

curl -i -X DELETE \
  'https://api.instantly.ai/api/v2/campaigns/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The deleted Campaign

Bodyapplication/json

idstring(uuid)read-onlyrequired

Unique identifier for the campaign

Example: "01959271-1f6b-7e4a-945f-5fb2c78db3e4"

namestringrequired

Name of the campaign

Example: "My First Campaign"

statusnumberread-onlyrequired

Campaign Status

Enum Value	Description
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-03-14T02:17:22.027Z"

campaign_schedule.end_datestring(date-time)

Example: "2025-03-14T02:17:22.027Z"

timestamp_createdstringread-onlyrequired

Timestamp when the campaign was created

Example: "2025-03-14T02:17:22.027Z"

timestamp_updatedstringread-onlyrequired

Timestamp when the campaign was last updated

Example: "2025-03-14T02:17:22.027Z"

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: ["01959271-1f6b-7e4a-945f-5fb3e28978e7"]

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: "01959271-1f6b-7e4a-945f-5fb40f0d1e62"

Response

application/json

{
  "id": "01959271-1f6b-7e4a-945f-5fb2c78db3e4",
  "name": "My First Campaign",
  "pl_value": 100,
  "status": 1,
  "is_evergreen": false,
  "campaign_schedule": {
    "start_date": "2025-03-14T02:17:22.027Z",
    "end_date": "2025-03-14T02:17:22.027Z",
    "schedules": [ … ]
  },
  "sequences": [
    { … }
  ],
  "timestamp_created": "2025-03-14T02:17:22.027Z",
  "timestamp_updated": "2025-03-14T02:17:22.027Z",
  "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": [
    "01959271-1f6b-7e4a-945f-5fb3e28978e7"
  ],
  "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": "01959271-1f6b-7e4a-945f-5fb40f0d1e62"
}

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)

Campaign ID

Example: id=01959271-2faa-733d-9614-15fe7004b989

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?end_date=2024-01-01&id=01959271-2faa-733d-9614-15fe7004b989&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [

campaign_namestring

The name of the campaign

Example: "Summer Sale Campaign"

campaign_idstring(uuid)

The ID of the campaign

Example: "01959271-2faa-733d-9614-15ff195a37e0"

leads_countinteger

The total number of leads

Example: 1500

contacted_countinteger

Number of leads for whom the sequence has started

Example: 1200

open_countinteger

The number of leads that opened at least one email

Example: 800

reply_countinteger

The number of leads that replied to at least one email

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

Example: 10

total_opportunity_valuenumber

The total value of opportunities created

Example: 1000

]

Response

application/json

[
  {
    "campaign_name": "Summer Sale Campaign",
    "campaign_id": "01959271-2faa-733d-9614-15ff195a37e0",
    "leads_count": 1500,
    "contacted_count": 1200,
    "open_count": 800,
    "reply_count": 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
  }
]

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: 01959271-2fab-779b-98f6-08a1b6b4d4c7

curl -i -X POST \
  https://api.instantly.ai/api/v2/campaigns/01959271-2fab-779b-98f6-08a1b6b4d4c7/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

Operations

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

API Explorer (2.0.0)

Analytics

Account

Campaign

Campaign

Create campaign

RequestExpand all

Responses

Was this helpful?

List campaign

Request

Responses

Was this helpful?

Activate(start), or resume a campaign

Request

Responses

Was this helpful?

Stop(or pause) a campaign

Request

Responses

Was this helpful?

Get campaign

Request

Responses

Was this helpful?

Patch campaign

RequestExpand all

Responses

Was this helpful?

Delete campaign

Request

Responses

Was this helpful?

Get campaign(s) analytics

Request

Responses

Was this helpful?

Share a campaign

Request

Responses

Was this helpful?

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace

Workspace Group Member

Workspace Member

Campaign Subsequence

Schemas

Request

Request