Instantly

Access the Instantly API v2 with managed authentication. Manage cold email campaigns, leads, sending accounts, and view analytics.

Quick Start

CODEBLOCK0

Base URL

CODEBLOCK1

Replace {native-api-path} with the actual Instantly API endpoint path. The gateway proxies requests to api.instantly.ai and automatically injects your API key.

Authentication

All requests require the Maton API key in the Authorization header:

CODEBLOCK2

Environment Variable: Set your API key as MATON_API_KEY:

CODEBLOCK3

Getting Your API Key

1. 1. Sign in or create an account at maton.ai
2. Go to maton.ai/settings
3. Copy your API key

Connection Management

Manage your Instantly connections at https://ctrl.maton.ai.

List Connections

CODEBLOCK4

Create Connection

CODEBLOCK5

Get Connection

CODEBLOCK6

Response:
CODEBLOCK7

Open the returned url in a browser to complete authorization.

Delete Connection

CODEBLOCK8

Specifying Connection

If you have multiple Instantly connections, specify which one to use with the Maton-Connection header:

CODEBLOCK9

If omitted, the gateway uses the default (oldest) active connection.

API Reference

Campaigns

List Campaigns

CODEBLOCK10

Query parameters:

• - limit - Number of results (default: 10)
• INLINECODE7 - Campaign status filter (0=draft, 1=active, 2=paused, 3=completed)
• INLINECODE8 - Search by campaign name
• INLINECODE9 - Cursor for pagination

Get Campaign

CODEBLOCK11

Create Campaign

CODEBLOCK12

Note: Timezone must use Etc/GMT format (e.g., "Etc/GMT+5", "Etc/GMT-8", "Etc/GMT+12").

#### Activate Campaign

bash
POST /instantly/api/v2/campaigns/{campaign_id}/activate

#### Pause Campaign

bash
POST /instantly/api/v2/campaigns/{campaign_id}/pause

#### Delete Campaign

bash
DELETE /instantly/api/v2/campaigns/{campaign_id}

#### Search Campaigns by Lead Email

bash
GET /instantly/api/v2/campaigns/search-by-contact?search=lead@example.com

### Leads

#### Create Lead

bash
POST /instantly/api/v2/leads
Content-Type: application/json

{
"campaign_id": "019bb3bd-9963-789e-b776-6c6927ef3f79",
"email": "lead@example.com",
"first_name": "John",
"last_name": "Doe",
"company_name": "Acme Inc",
"variables": {
"customfield": "customvalue"
}
}

#### Bulk Add Leads

bash
POST /instantly/api/v2/leads
Content-Type: application/json

{
"campaign_id": "019bb3bd-9963-789e-b776-6c6927ef3f79",
"leads": [
{
"email": "lead1@example.com",
"first_name": "John"
},
{
"email": "lead2@example.com",
"first_name": "Jane"
}
]
}

#### List Leads

Note: This is a POST endpoint due to complex filtering requirements.

bash
POST /instantly/api/v2/leads/list
Content-Type: application/json

{
"campaign_id": "019bb3bd-9963-789e-b776-6c6927ef3f79",
"limit": 100
}

#### Get Lead

bash
GET /instantly/api/v2/leads/{lead_id}

#### Delete Lead

bash
DELETE /instantly/api/v2/leads/{lead_id}

#### Move Leads

bash
POST /instantly/api/v2/leads/move
Content-Type: application/json

{
"leadids": ["leadid1", "leadid_2"],
"tocampaignid": "targetcampaignid"
}

### Lead Lists

#### List Lead Lists

bash
GET /instantly/api/v2/lead-lists?limit=10

#### Create Lead List

bash
POST /instantly/api/v2/lead-lists
Content-Type: application/json

{
"name": "My Lead List"
}

#### Get Lead List

bash
GET /instantly/api/v2/lead-lists/{list_id}

#### Update Lead List

bash
PATCH /instantly/api/v2/lead-lists/{list_id}
Content-Type: application/json

{
"name": "Updated List Name"
}

#### Delete Lead List

bash
DELETE /instantly/api/v2/lead-lists/{list_id}

### Accounts (Sending Email Accounts)

#### List Accounts

bash
GET /instantly/api/v2/accounts?limit=10

#### Get Account

bash
GET /instantly/api/v2/accounts/{email}

#### Create Account

bash
POST /instantly/api/v2/accounts
Content-Type: application/json

{
"email": "sender@example.com",
"first_name": "John",
"last_name": "Doe",
"provider_code": "google",
"smtp_host": "smtp.gmail.com",
"smtp_port": 587,
"smtp_username": "sender@example.com",
"smtppassword": "apppassword",
"imap_host": "imap.gmail.com",
"imap_port": 993,
"imap_username": "sender@example.com",
"imappassword": "apppassword"
}

#### Update Account

bash
PATCH /instantly/api/v2/accounts/{email}
Content-Type: application/json

{
"first_name": "Jane"
}

#### Delete Account

bash
DELETE /instantly/api/v2/accounts/{email}

#### Enable Warmup

bash
POST /instantly/api/v2/accounts/warmup/enable
Content-Type: application/json

{
"emails": ["account1@example.com", "account2@example.com"]
}

#### Disable Warmup

bash
POST /instantly/api/v2/accounts/warmup/disable
Content-Type: application/json

{
"emails": ["account1@example.com"]
}

### Emails (Unibox)

#### List Emails

bash
GET /instantly/api/v2/emails?limit=20

#### Get Email

bash
GET /instantly/api/v2/emails/{email_id}

#### Reply to Email

bash
POST /instantly/api/v2/emails/reply
Content-Type: application/json

{
"replytouuid": "email_uuid",
"body": "Thank you for your response!"
}

#### Forward Email

bash
POST /instantly/api/v2/emails/forward
Content-Type: application/json

{
"emailuuid": "emailuuid",
"to": "forward@example.com"
}

#### Mark Thread as Read

bash
POST /instantly/api/v2/emails/threads/{thread_id}/mark-as-read

#### Get Unread Count

bash
GET /instantly/api/v2/emails/unread/count

#### Update Email

bash
PATCH /instantly/api/v2/emails/{email_id}
Content-Type: application/json

{
"is_read": true
}

#### Delete Email

bash
DELETE /instantly/api/v2/emails/{email_id}

### Analytics

#### Get Campaign Analytics

bash
GET /instantly/api/v2/campaigns/analytics?id={campaign_id}

Query parameters:
- `id` - Campaign ID (leave empty for all campaigns)
- `start_date` - Filter start date (YYYY-MM-DD)
- `end_date` - Filter end date (YYYY-MM-DD)
- `exclude_total_leads_count` - Set to true for faster response

#### Get Campaign Analytics Overview

bash
GET /instantly/api/v2/campaigns/analytics/overview?id={campaign_id}

#### Get Daily Campaign Analytics

bash
GET /instantly/api/v2/campaigns/analytics/daily?id={campaign_id}

#### Get Campaign Step Analytics

bash
GET /instantly/api/v2/campaigns/analytics/steps?id={campaign_id}

#### Get Warmup Analytics

bash
POST /instantly/api/v2/accounts/warmup/analytics
Content-Type: application/json

{
"emails": ["account@example.com"]
}

### Block List

#### List Block List Entries

bash
GET /instantly/api/v2/block-lists-entries?limit=100

Query parameters:
- `domains_only` - Filter to domain entries only
- `search` - Search entries

#### Create Block List Entry

bash
POST /instantly/api/v2/block-lists-entries
Content-Type: application/json

{
"bl_value": "blocked@example.com"
}

Or block a domain:

bash
POST /instantly/api/v2/block-lists-entries
Content-Type: application/json

{
"bl_value": "blockeddomain.com"
}

#### Delete Block List Entry

bash
DELETE /instantly/api/v2/block-lists-entries/{entry_id}

### Email Verification

#### Verify Email

bash
GET /instantly/api/v2/email-verification/{email}

If verification takes longer than 10 seconds, status will be `pending`. Poll this endpoint to check status.

Response fields:
- `verification_status` - Use this field (not `status`) to determine verification result

### Background Jobs

#### Get Background Job Status

bash
GET /instantly/api/v2/background-jobs/{job_id}

Query parameters:
- `data_fields` - Comma-separated fields (e.g., `success_count,failed_count,total_to_process`)

### Workspace

#### Get Current Workspace

bash
GET /instantly/api/v2/workspaces/current

### Custom Tags

#### Toggle Tag on Resource

bash
POST /instantly/api/v2/custom-tags/toggle-resource
Content-Type: application/json

{
"tagid": "taguuid",
"resourceid": "campaignoraccountid",
"resource_type": "campaign"
}

## Pagination

Instantly uses cursor-based pagination with `limit` and `starting_after`:

bash
GET /instantly/api/v2/campaigns?limit=10&startingafter=cursorvalue

Response includes pagination info:

json
{
"items": [...],
"nextstartingafter": "cursorfornext_page"
}

Use `next_starting_after` value in the next request's `starting_after` parameter.

## Code Examples

### JavaScript

javascript
const response = await fetch(
'https://gateway.maton.ai/instantly/api/v2/campaigns?limit=10',
{
headers: {
'Authorization': Bearer ${process.env.MATON_API_KEY}
}
}
);
const data = await response.json();

### Python

python
import os
import requests

response = requests.get(
'https://gateway.maton.ai/instantly/api/v2/campaigns',
headers={'Authorization': f'Bearer {os.environ["MATONAPIKEY"]}'},
params={'limit': 10}
)
data = response.json()

## Notes

- Instantly API v2 uses snake_case for all field names
- Lead custom variables must be string, number, boolean, or null (no objects/arrays)
- The List Leads endpoint is POST (not GET) due to complex filtering requirements
- Campaign status values: 0=draft, 1=active, 2=paused, 3=completed
- Email verification may return `pending` status if it takes longer than 10 seconds
- Warmup operations return background job IDs - poll the background jobs endpoint for status
- IMPORTANT: When using curl commands, use `curl -g` when URLs contain brackets to disable glob parsing
- IMPORTANT: When piping curl output to `jq`, environment variables may not expand correctly. Use Python examples instead.

## Error Handling

| Status | Meaning |
|--------|---------|
| 400 | Missing Instantly connection or invalid request |
| 401 | Invalid or missing Maton API key |
| 403 | Insufficient API key scopes |
| 429 | Rate limited |
| 4xx/5xx | Passthrough error from Instantly API |

### Troubleshooting: API Key Issues

1. Check that the `MATON_API_KEY` environment variable is set:

bash
echo $MATONAPIKEY

2. Verify the API key is valid by listing connections:

bash
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections')
req.addheader('Authorization', f'Bearer {os.environ["MATONAPI_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
`` ### Troubleshooting: Invalid App Name 1. Ensure your URL path starts with instantly. For example: - Correct: https://gateway.maton.ai/instantly/api/v2/campaigns - Incorrect: https://gateway.maton.ai/api/v2/campaigns`

Resources

• - Instantly API V2 Documentation
• Instantly API Introduction
• Instantly Help Center
• Maton Community
• Maton Support