| Enum Value | Description |
|---|---|
| 0 | Paused |
| 1 | Active |
| -1 | Banned |
| -2 | Spam Folder Unknown |
| -3 | Permanent Suspension |
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/accounts/{email}/pause
https://developer.instantly.ai/_mock/api/v2/api/v2/accounts/{email}/pause
curl -i -X POST \
https://api.instantly.ai/api/v2/accounts/user@example.com/pause \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Account
Timestamp when the account was created
Timestamp when the account was last updated
Organization ID that owns this account
Current warmup status of the account
| Enum Value | Description |
|---|---|
| 0 | Paused |
| 1 | Active |
| -1 | Banned |
| -2 | Spam Folder Unknown |
| -3 | Permanent Suspension |
Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.
| Enum Value | Description |
|---|---|
| 1 | Custom IMAP/SMTP |
| 2 | |
| 3 | Microsoft |
| 4 | AWS |
User ID who added the account
User ID who last modified the account
Current status of the account
| Enum Value | Description |
|---|---|
| 1 | Active |
| 2 | Paused |
| -1 | Connection Error |
| -2 | Soft Bounce Error |
| -3 | Sending Error |
Timestamp when the account was last used
Timestamp when warmup was started
ID of the warmup pool this account belongs to
{ "email": "user@example.com", "timestamp_created": "2025-12-22T22:48:00.179Z", "timestamp_updated": "2025-12-22T22:48:00.179Z", "first_name": "John", "last_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup_custom_ftag": "warmup", "increment": "disabled", "reply_rate": 0.1 }, "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8", "daily_limit": 100, "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e", "tracking_domain_name": "example.com", "tracking_domain_status": "active", "status": 1, "enable_slow_ramp": false, "inbox_placement_test_limit": 10, "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39", "timestamp_last_used": "2025-12-22T22:48:00.179Z", "warmup_status": 1, "status_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp_warmup_start": "2025-12-22T22:48:00.179Z", "provider_code": 2, "setup_pending": false, "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4", "is_managed_account": false, "dfy_password_changed": false, "stat_warmup_score": 85, "sending_gap": 10 }
https://api.instantly.ai/api/v2/accounts/{email}/resume
https://developer.instantly.ai/_mock/api/v2/api/v2/accounts/{email}/resume
curl -i -X POST \
https://api.instantly.ai/api/v2/accounts/user@example.com/resume \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Account
Timestamp when the account was created
Timestamp when the account was last updated
Organization ID that owns this account
Current warmup status of the account
| Enum Value | Description |
|---|---|
| 0 | Paused |
| 1 | Active |
| -1 | Banned |
| -2 | Spam Folder Unknown |
| -3 | Permanent Suspension |
Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.
| Enum Value | Description |
|---|---|
| 1 | Custom IMAP/SMTP |
| 2 | |
| 3 | Microsoft |
| 4 | AWS |
User ID who added the account
User ID who last modified the account
Current status of the account
| Enum Value | Description |
|---|---|
| 1 | Active |
| 2 | Paused |
| -1 | Connection Error |
| -2 | Soft Bounce Error |
| -3 | Sending Error |
Timestamp when the account was last used
Timestamp when warmup was started
ID of the warmup pool this account belongs to
{ "email": "user@example.com", "timestamp_created": "2025-12-22T22:48:00.179Z", "timestamp_updated": "2025-12-22T22:48:00.179Z", "first_name": "John", "last_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup_custom_ftag": "warmup", "increment": "disabled", "reply_rate": 0.1 }, "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8", "daily_limit": 100, "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e", "tracking_domain_name": "example.com", "tracking_domain_status": "active", "status": 1, "enable_slow_ramp": false, "inbox_placement_test_limit": 10, "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39", "timestamp_last_used": "2025-12-22T22:48:00.179Z", "warmup_status": 1, "status_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp_warmup_start": "2025-12-22T22:48:00.179Z", "provider_code": 2, "setup_pending": false, "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4", "is_managed_account": false, "dfy_password_changed": false, "stat_warmup_score": 85, "sending_gap": 10 }
https://api.instantly.ai/api/v2/accounts/{email}/mark-fixed
https://developer.instantly.ai/_mock/api/v2/api/v2/accounts/{email}/mark-fixed
curl -i -X POST \
https://api.instantly.ai/api/v2/accounts/user@example.com/mark-fixed \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The requested Account
Timestamp when the account was created
Timestamp when the account was last updated
Organization ID that owns this account
Current warmup status of the account
| Enum Value | Description |
|---|---|
| 0 | Paused |
| 1 | Active |
| -1 | Banned |
| -2 | Spam Folder Unknown |
| -3 | Permanent Suspension |
Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work.
| Enum Value | Description |
|---|---|
| 1 | Custom IMAP/SMTP |
| 2 | |
| 3 | Microsoft |
| 4 | AWS |
User ID who added the account
User ID who last modified the account
Current status of the account
| Enum Value | Description |
|---|---|
| 1 | Active |
| 2 | Paused |
| -1 | Connection Error |
| -2 | Soft Bounce Error |
| -3 | Sending Error |
Timestamp when the account was last used
Timestamp when warmup was started
ID of the warmup pool this account belongs to
{ "email": "user@example.com", "timestamp_created": "2025-12-22T22:48:00.179Z", "timestamp_updated": "2025-12-22T22:48:00.179Z", "first_name": "John", "last_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup_custom_ftag": "warmup", "increment": "disabled", "reply_rate": 0.1 }, "added_by": "019b483f-81b3-7bef-9fcc-16531eb5fdd8", "daily_limit": 100, "modified_by": "019b483f-81b3-7bef-9fcc-1654dca0eb9e", "tracking_domain_name": "example.com", "tracking_domain_status": "active", "status": 1, "enable_slow_ramp": false, "inbox_placement_test_limit": 10, "organization": "019b483f-81b3-7bef-9fcc-1655446f3d39", "timestamp_last_used": "2025-12-22T22:48:00.179Z", "warmup_status": 1, "status_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp_warmup_start": "2025-12-22T22:48:00.179Z", "provider_code": 2, "setup_pending": false, "warmup_pool_id": "019b483f-81b3-7bef-9fcc-1656572bf9d4", "is_managed_account": false, "dfy_password_changed": false, "stat_warmup_score": 85, "sending_gap": 10 }
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.