| 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}
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}
curl -i -X GET \
https://api.instantly.ai/api/v2/campaigns/019aeda4-f98f-7e1c-a544-f4ae14956982 \
-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": "019aeda4-e77f-7641-9806-9ae958868b7b", "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-05T08:33:18.719Z", "timestamp_updated": "2025-12-05T08:33:18.719Z", "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": [ "019aeda4-e77f-7641-9806-9aea91e0e310" ], "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": "019aeda4-e77f-7641-9806-9aebe5bc2bac", "owned_by": "019aeda4-e77f-7641-9806-9aec28651207", "ai_sdr_id": "019aeda4-e77f-7641-9806-9aed3eb5bf90", "provider_routing_rules": [ { … } ] }
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.
https://api.instantly.ai/api/v2/campaigns/{id}
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}
curl -i -X PATCH \
https://api.instantly.ai/api/v2/campaigns/019aeda4-f99a-7dcd-87a8-96ce1c9d34d7 \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'The updated 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": "019aeda4-e77f-7641-9806-9ae958868b7b", "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-05T08:33:18.719Z", "timestamp_updated": "2025-12-05T08:33:18.719Z", "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": [ "019aeda4-e77f-7641-9806-9aea91e0e310" ], "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": "019aeda4-e77f-7641-9806-9aebe5bc2bac", "owned_by": "019aeda4-e77f-7641-9806-9aec28651207", "ai_sdr_id": "019aeda4-e77f-7641-9806-9aed3eb5bf90", "provider_routing_rules": [ { … } ] }
https://api.instantly.ai/api/v2/campaigns/{id}
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/{id}
curl -i -X DELETE \
https://api.instantly.ai/api/v2/campaigns/019aeda4-f99a-7dcd-87a8-96cf0903bc8b \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json'The deleted 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": "019aeda4-e77f-7641-9806-9ae958868b7b", "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-05T08:33:18.719Z", "timestamp_updated": "2025-12-05T08:33:18.719Z", "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": [ "019aeda4-e77f-7641-9806-9aea91e0e310" ], "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": "019aeda4-e77f-7641-9806-9aebe5bc2bac", "owned_by": "019aeda4-e77f-7641-9806-9aec28651207", "ai_sdr_id": "019aeda4-e77f-7641-9806-9aed3eb5bf90", "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.