| 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/
https://api.instantly.ai/api/v2/campaigns/{id}/export
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}/export
curl -i -X POST \
https://api.instantly.ai/api/v2/campaigns/019a1a23-3ed4-7ce5-9561-f1a840aeafe9/export \
-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
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
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
{ "id": "019a1a23-24b9-77cf-9802-4d6d2fffb441", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-10-25T06:51:42.136Z", "end_date": "2025-10-25T06:51:42.136Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-10-25T06:51:42.137Z", "timestamp_updated": "2025-10-25T06:51:42.137Z", "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": [ "019a1a23-24b9-77cf-9802-4d6e41ce5e99" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": null, "match_lead_esp": false, "stop_for_company": false, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "limit_emails_per_company_override": null, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "019a1a23-24b9-77cf-9802-4d6f0a9ef77a", "owned_by": "019a1a23-24b9-77cf-9802-4d701d73f1bc", "provider_routing_rules": [ { … } ] }
https://api.instantly.ai/api/v2/campaigns/{id}/duplicate
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}/duplicate
curl -i -X POST \
https://api.instantly.ai/api/v2/campaigns/019a1a23-3ed4-7ce5-9561-f1a90cf48766/duplicate \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'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
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
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
{ "id": "019a1a23-24b9-77cf-9802-4d6d2fffb441", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-10-25T06:51:42.136Z", "end_date": "2025-10-25T06:51:42.136Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-10-25T06:51:42.137Z", "timestamp_updated": "2025-10-25T06:51:42.137Z", "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": [ "019a1a23-24b9-77cf-9802-4d6e41ce5e99" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": null, "match_lead_esp": false, "stop_for_company": false, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "limit_emails_per_company_override": null, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "019a1a23-24b9-77cf-9802-4d6f0a9ef77a", "owned_by": "019a1a23-24b9-77cf-9802-4d701d73f1bc", "provider_routing_rules": [ { … } ] }
https://api.instantly.ai/api/v2/campaigns/count-launched
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/count-launched
curl -i -X GET \
https://api.instantly.ai/api/v2/campaigns/count-launched \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "count": 2 }