| 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/analytics/steps
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/analytics/steps
curl -i -X GET \
'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign_id=019942fb-7279-7d0f-9a27-382be6510e84&end_date=2024-01-01&start_date=2024-01-01' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Default Response
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
[ { "step": "1", "variant": "0", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60 } ]
https://api.instantly.ai/api/v2/campaigns/{id}/from-export
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}/from-export
curl -i -X POST \
https://api.instantly.ai/api/v2/campaigns/019942fb-727c-7e5b-a275-3346e5532b6b/from-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
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
{ "id": "019942fb-54a1-73dc-89a2-5f7483674a3d", "name": "My First Campaign", "pl_value": 100, "status": 1, "is_evergreen": false, "campaign_schedule": { "start_date": "2025-09-13T12:09:51.520Z", "end_date": "2025-09-13T12:09:51.520Z", "schedules": [ … ] }, "sequences": [ { … } ], "timestamp_created": "2025-09-13T12:09:51.521Z", "timestamp_updated": "2025-09-13T12:09:51.521Z", "email_gap": 10, "random_wait_max": 10, "text_only": false, "email_list": [ "john@doe.com" ], "daily_limit": 100, "stop_on_reply": false, "email_tag_list": [ "019942fb-54a1-73dc-89a2-5f751b858434" ], "link_tracking": true, "open_tracking": true, "stop_on_auto_reply": false, "daily_max_leads": 100, "prioritize_new_leads": false, "auto_variant_select": { "trigger": "click_rate" }, "match_lead_esp": false, "stop_for_company": false, "insert_unsubscribe_header": false, "allow_risky_contacts": false, "disable_bounce_protect": false, "cc_list": [ "john@doe.com" ], "bcc_list": [ "john@doe.com" ], "organization": "019942fb-54a1-73dc-89a2-5f7657542db6" }