openclaw-backups/skills/api-gateway/references/instantly.md

Instantly Routing Reference

App name: instantly Base URL proxied: api.instantly.ai

API Path Pattern

/instantly/api/v2/{resource}

Common Endpoints

Campaigns

List Campaigns

GET /instantly/api/v2/campaigns?limit=10

Get Campaign

GET /instantly/api/v2/campaigns/{campaign_id}

Create Campaign

POST /instantly/api/v2/campaigns

Activate Campaign

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

Pause Campaign

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

Delete Campaign

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

Get Campaign Analytics

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

Leads

Create Lead

POST /instantly/api/v2/leads

List Leads (POST due to complex filtering)

POST /instantly/api/v2/leads/list

Get Lead

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

Delete Lead

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

Lead Lists

List Lead Lists

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

Create Lead List

POST /instantly/api/v2/lead-lists

Get Lead List

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

Update Lead List

PATCH /instantly/api/v2/lead-lists/{list_id}

Delete Lead List

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

Accounts (Sending Email Accounts)

List Accounts

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

Get Account

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

Create Account

POST /instantly/api/v2/accounts

Update Account

PATCH /instantly/api/v2/accounts/{email}

Delete Account

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

Enable Warmup

POST /instantly/api/v2/accounts/warmup/enable

Disable Warmup

POST /instantly/api/v2/accounts/warmup/disable

Emails (Unibox)

List Emails

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

Reply to Email

POST /instantly/api/v2/emails/reply

Forward Email

POST /instantly/api/v2/emails/forward

Block List

List Block List Entries

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

Create Block List Entry

POST /instantly/api/v2/block-lists-entries

Delete Block List Entry

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

Workspace

Get Current Workspace

GET /instantly/api/v2/workspaces/current

Notes

• API v2 uses snake_case for all field names
• Campaign timezone must use Etc/GMT format (e.g., "Etc/GMT+5")
• List Leads is POST (not GET) due to complex filtering
• Cursor-based pagination with limit and starting_after
• Campaign status: 0=draft, 1=active, 2=paused, 3=completed

Resources

• Instantly API V2 Documentation