| Enum Value | Description |
|---|---|
| 0 | Draft |
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
| 4 | Running Subsequences |
| -99 | Account Suspended |
| -1 | Accounts Unhealthy |
| -2 | Bounce Protect |
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.
https://api.instantly.ai/
https://developer.instantly.ai/_mock/api/v2/
The Campaign to create
Campaign schedule
Start date in YYYY-MM-DD format. Uses the campaign's timezone.
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
Whether the campaign is send the first email as a text only
List of tags to use for sending emails
Whether to stop the campaign for the entire company(domain) when a lead replies
Whether to insert an unsubscribe header in emails
Overrides the workspace-wide limit emails per company setting for this campaign.
AI SDR ID that created this campaign
https://api.instantly.ai/api/v2/campaigns
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns
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"
}
]
}
}'The Campaign
Unique identifier for the campaign
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 |
Campaign schedule
Start date in YYYY-MM-DD format. Uses the campaign's timezone.
Timestamp when the campaign was created
Timestamp when the campaign was last updated
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
Whether the campaign is send the first email as a text only
List of tags to use for sending emails
Campaign not sending status
| Enum Value | Description |
|---|---|
| 1 | Campaign is currently not within its sending schedule. |
| 2 | Campaign is currently waiting for a lead to process. |
| 3 | Campaign has reached its daily sending limit. |
| 4 | All sending accounts for this campaign have reached their daily sending limit. |
| 99 | Campaign is currently not sending due to an error. Please contact support for assistance. |
Whether to stop the campaign for the entire company(domain) when a lead replies
Whether to insert an unsubscribe header in emails
Overrides the workspace-wide limit emails per company setting for this campaign.
Organization ID
AI SDR ID that created this campaign
{ "id": "019b708d-e61e-7a16-9d3a-955343ecbc84", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-09-25", "end_date": "2025-09-25", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-12-30T18:38:26.334Z", "timestamp_updated": "2025-12-30T18:38:26.334Z", "email_gap": 10, "random_wait_max": 10, "text_only": false, "first_email_text_only": false, "email_list": [ "john@doe.com" ], "daily_limit": 100, "stop_on_reply": false, "email_tag_list": [ "019b708d-e61e-7a16-9d3a-95545aaacc55" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": null, "match_lead_esp": false, "not_sending_status": 2, "stop_for_company": false, "core_variables": null, "custom_variables": null, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "limit_emails_per_company_override": null, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "019b708d-e61e-7a16-9d3a-9555fa050914", "owned_by": "019b708d-e61e-7a16-9d3a-95561fea7ae2", "ai_sdr_id": "019b708d-e61e-7a16-9d3a-95573e3c0ba8", "provider_routing_rules": [ { … } ] }
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.
Filter campaigns by tag ids. Returns campaigns that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma.
Filter campaigns by AI SDR ID. Returns campaigns that were created by the specified AI SDR.
https://api.instantly.ai/api/v2/campaigns
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns
curl -i -X GET \
'https://api.instantly.ai/api/v2/campaigns?ai_sdr_id=019b708e-04eb-7658-b52c-b530271db3d6&limit=10&search=Summer%20Sale%20Campaign&starting_after=01956fbd-0eb1-72db-a565-82977a586084&status=1&tag_ids=019b708e-04eb-7658-b52c-b52e731de0fb%2C019b708e-04eb-7658-b52c-b52f470a5f4f' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The list of Campaign
The list of Campaign
Unique identifier for the campaign
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 |
Campaign schedule
Start date in YYYY-MM-DD format. Uses the campaign's timezone.
Timestamp when the campaign was created
Timestamp when the campaign was last updated
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
Whether the campaign is send the first email as a text only
List of accounts to use for sending emails
List of tags to use for sending emails
Whether to stop the campaign on auto reply
Campaign not sending status
| Enum Value | Description |
|---|---|
| 1 | Campaign is currently not within its sending schedule. |
| 2 | Campaign is currently waiting for a lead to process. |
| 3 | Campaign has reached its daily sending limit. |
| 4 | All sending accounts for this campaign have reached their daily sending limit. |
| 99 | Campaign is currently not sending due to an error. Please contact support for assistance. |
Whether to stop the campaign for the entire company(domain) when a lead replies
Whether to insert an unsubscribe header in emails
Overrides the workspace-wide limit emails per company setting for this campaign.
List of accounts to BCC on emails
Organization ID
AI SDR ID that created this campaign
{ "items": [ { … } ], "next_starting_after": "019b708e-04ec-7177-adfe-33a90a5c0c26" }
https://api.instantly.ai/api/v2/campaigns/{id}/activate
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}/activate
curl -i -X POST \
https://api.instantly.ai/api/v2/campaigns/019b708e-04e9-7f82-b640-81bbfdf9ae44/activate \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Campaign
Unique identifier for the campaign
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 |
Campaign schedule
Start date in YYYY-MM-DD format. Uses the campaign's timezone.
Timestamp when the campaign was created
Timestamp when the campaign was last updated
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
Whether the campaign is send the first email as a text only
List of tags to use for sending emails
Campaign not sending status
| Enum Value | Description |
|---|---|
| 1 | Campaign is currently not within its sending schedule. |
| 2 | Campaign is currently waiting for a lead to process. |
| 3 | Campaign has reached its daily sending limit. |
| 4 | All sending accounts for this campaign have reached their daily sending limit. |
| 99 | Campaign is currently not sending due to an error. Please contact support for assistance. |
Whether to stop the campaign for the entire company(domain) when a lead replies
Whether to insert an unsubscribe header in emails
Overrides the workspace-wide limit emails per company setting for this campaign.
Organization ID
AI SDR ID that created this campaign
{ "id": "019b708d-e61e-7a16-9d3a-955343ecbc84", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-09-25", "end_date": "2025-09-25", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-12-30T18:38:26.334Z", "timestamp_updated": "2025-12-30T18:38:26.334Z", "email_gap": 10, "random_wait_max": 10, "text_only": false, "first_email_text_only": false, "email_list": [ "john@doe.com" ], "daily_limit": 100, "stop_on_reply": false, "email_tag_list": [ "019b708d-e61e-7a16-9d3a-95545aaacc55" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": null, "match_lead_esp": false, "not_sending_status": 2, "stop_for_company": false, "core_variables": null, "custom_variables": null, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "limit_emails_per_company_override": null, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "019b708d-e61e-7a16-9d3a-9555fa050914", "owned_by": "019b708d-e61e-7a16-9d3a-95561fea7ae2", "ai_sdr_id": "019b708d-e61e-7a16-9d3a-95573e3c0ba8", "provider_routing_rules": [ { … } ] }
This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (tag_id field) with the email account (resource_id field). You can use it to see which tag si connected to which resource.