| 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=019a5522-8616-790c-833f-2ca0cdbcc6e3&end_date=2024-01-01&include_opportunities_count=true&start_date=2024-01-01' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Default Response
The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.
The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.
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
The total number of opportunities created from this step. Included only if include_opportunities_count is true
The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if include_opportunities_count is true
[ { "step": "1", "variant": "0", "sent": 5421, "opened": 99, "unique_opened": 60, "replies": 60, "unique_replies": 60, "clicks": 60, "unique_clicks": 60, "opportunities": 10, "unique_opportunities": 8 } ]
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/019a5522-8619-772c-a073-8ba883a0dc4e/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
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
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": "019a5522-76c0-7cc0-9cf0-d0d62ccfd73d", "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-11-05T17:48:33.344Z", "timestamp_updated": "2025-11-05T17:48:33.344Z", "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": [ "019a5522-76c0-7cc0-9cf0-d0d741481643" ], "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": "019a5522-76c0-7cc0-9cf0-d0d8e1df8a2d", "owned_by": "019a5522-76c0-7cc0-9cf0-d0d9165bda99", "provider_routing_rules": [ { … } ] }