API review

Instantly API review

Cold-email sending platform with unlimited mailboxes and warmup, a scoped-key REST API v2 (255 operations in the spec), a hosted MCP server auto-generated from that spec (199 tools live on 2026-10-25), and a separate credits subscription for its 450M+ lead database and AI agents. Best for cheapest entry to API-driven cold email: API v2 is on every paid Outreach plan from Growth, and in our test it also worked on the 14-day free trial.

Verified 25 Oct 2026 · 255 endpoints listed · Official MCP server

See pricing

Instantly API docs

What a call costs

The actions you pay for, as Instantly prices them.

Action	Cost	Per
Work email find (Lead Finder / enrichment)	~1.5 (1-2) credits	per row
Fully enriched profile	0.5 credits	per row
AI enrichment	~0.5 credits	per row
Lead verification	0.25 credits	per lead (measured 0.25 on our trial, 2026-10-25)
AI Reply Agent	5 credits	per reply generated
AI Sales Agent	5 credits	per lead generated
Pre-warmed Google account	$10	per month
Done-for-you Google account	$5	per month

Show all 17 priced actionsHide the rest

Action	Cost	Per
Domain (DFY / pre-warmed)	$15	per year
SuperSearch / Lead Finder count and preview (API)	free	per call (measured; preview hides emails)
Company enrichment: job listings, technologies, news, funding type	0.5 credits	per row, each
Engagement score	1 credit	per row
Website Visitors resolved profile	3 credits	per resolved profile
Find Local Businesses	2 credits	per business
Find Creators	50 credits (+25 for audience insights)	per creator
AI Recruiting / Investment / User Research / Partnership agents	5 credits	per lead generated
Instantly AirMail email account	$4	per month

Pricing, plan by plan

US dollars, as Instantly's pricing page shows them on 25 Oct 2026. Monthly and annual billing are shown apart.

Free tier 14-day free trial, no card. Docs: 250 uploaded contacts, 1,000 emails, 100 credits, no API.

Outreach Growth

$47/mo

billed monthly

$37.60/mo

billed annually

5,000 emails/mo, 1,000 uploaded contacts (fixed, does not reset monthly); Unibox preview-only (reply from Unibox needs Hypergrowth)

API included

Plan details

no overage; upgrade tier

Outreach Hypergrowth

$97/mo

billed monthly

$77.60/mo

billed annually

125,000 emails/mo, 25,000 uploaded contacts; webhooks, subsequences, workspaces

API included

Plan details

add-on $87/mo per +25,000 uploaded contacts / +125,000 emails / +500 SMTP accounts in the standard warmup pool; stackable; removal via support

Outreach Light Speed

$358/mo

billed monthly

$286.30/mo

billed annually

500,000 emails/mo, 100,000 uploaded contacts, SISR private servers/IPs

API included

Plan details

add-on $87/mo per +25,000 contacts / +125,000 emails (stackable)

Outreach Enterprise

Custom quote

500,000+ emails, 100,000+ contacts, private deliverability network

API included

Plan details

custom

Credits Nano

$9/mo

billed monthly

$9/mo

monthly billing only

150 credits/mo

Credits Growth

$47/mo

billed monthly

$42.30/mo

billed annually

1,500 credits/mo at $47; 2,000 credits/mo at $77 ('Growth credits 2')

Show all 15 plansShow fewer plans

Credits Supersonic

$97/mo

billed monthly

$87.30/mo

billed annually

5,000 credits/mo at $97; 7,500 credits/mo at $147 ('Supersonic credits 2')

Hyper Credits

$197/mo

billed monthly

$177.30/mo

billed annually

tiers: $197 = 10,000; $300 = 20,000; $500 = 45,000; $997 = 100,000; $1,400 = 150,000; $1,700 = 200,000 credits/mo

Plan details

Credits add-on $425/mo for +50,000

Bundle Starter (Growth + Growth Credits 1,500)

$94/mo

billed monthly

$85/mo

billed annually

5,000 emails/mo, 1,000 uploaded contacts, 1,500 credits/mo

API included

Bundle Scale (app: Hyper Growth + Hyper Credits 10,000)

$294/mo

billed monthly

$265/mo

billed annually

125,000 emails/mo, 25,000 uploaded contacts, 10,000 credits/mo

API included

Bundle Agency (app: Light Speed + Hyper Credits Tier 3, 45,000)

$858/mo

billed monthly

$772/mo

billed annually

500,000 emails/mo, 100,000 uploaded contacts, 45,000 credits/mo, SISR

API included

Add-on Growth CRM

$47/mo

billed monthly

$47/mo

monthly billing only

AI CRM: emails, calls, SMS, tasks, LinkedIn connections

Add-on Hyper CRM

$97/mo

billed monthly

$97/mo

monthly billing only

Growth CRM + calling and SMS (the app's Calls & SMS page says 'Subscribe to the Hyper CRM plan')

Add-on Growth Inbox Placement

$47/mo

billed monthly

$47/mo

monthly billing only

unlimited one-time inbox-placement tests

Add-on Hypergrowth Inbox Placement

$97/mo

billed monthly

$97/mo

monthly billing only

unlimited one-time and automated tests

Rate limits

Shared by API v1 and v2 across the whole workspace, even with multiple keys: max 100 requests/second and 6,000 requests/minute; exceeding either returns 429.

How to get an API key

Instantly uses API key. The steps below follow Instantly's own docs.

Create a Instantly account. API access starts on the Outreach Growth plan.
Settings -> Integrations -> API Keys (Version 2) -> Create API Key: name + scopes (the in-app picker listed 128 scopes, all:* and per-resource:all/:create/:read/:update/:delete; scopes cannot be changed after creation). Shown once, unrecoverable (GET /api/v2/api-keys returns key: ""). v2 keys differ from v1 keys.
Send it with every request: header: Authorization: Bearer <key>.
Make a first call: Get campaigns associated with an email, Requires one of the following scopes: account_campaign_mappings:read, account_campaign_mappings:all, all:read, all:all. Keep the key in an environment variable, never in the command.
```
curl -X GET "https://api.instantly.ai/api/v2/account-campaign-mappings/{email}" \
  -H "Authorization: Bearer $INSTANTLY_API_KEY"
```

Where the docs live

What	Where
Documentation	developer.instantly.ai/index.md
API reference	developer.instantly.ai/api-reference/introduction.md
OpenAPI spec	api.instantly.ai/openapi/api_v2.json
llms.txt	developer.instantly.ai/llms.txt
Changelog	feedback.instantly.ai/changelog
Base URL	`https://api.instantly.ai`
MCP server	`https://mcp.instantly.ai/mcp`
SDKs	@instantlyai/sdk (TypeScript, beta, Node 22+), @instantlyai/cli (npm, includes local MCP via `instantly mcp`)

Strengths and limits

Where it fits

Cheapest entry to API-driven cold email: API v2 is on every paid Outreach plan from Growth ($47/mo), and in our test it also worked on the 14-day free trial
Agents and LLM tooling: hosted MCP at mcp.instantly.ai (199 tools in tools/list on 2026-10-25; docs say 'every v2 endpoint'), plus an npm CLI with a local MCP
Least-privilege integrations: per-key scopes (e.g. campaigns:read, leads:all)
Programmatic mailbox provisioning: OAuth connect flows and done-for-you account/domain orders via API

Where it falls short

Webhook-driven reply capture on the Growth plan: help center and pricing gate webhooks to Hypergrowth ($97/mo) and above (the Webhooks tab still shows 'Add Webhook' on the free trial; creating one was not tested)
Reselling or building data products from enriched/visitor data: the terms ban any 'Data Resale Activity'
Polling the email/inbox list heavily: GET /api/v2/emails is capped at 20 requests/minute

Worth knowing

API v1 was deprecated on 19 Jan 2026; v2 needs a NEW key, v1 keys do not work on v2.
Help center and pricing say API is on every paid plan but not on the free trial; in our 2026-10-25 trial, API keys and v2 calls worked on plan pid_free. Webhooks and Slack are gated to Hypergrowth ($97/mo) in the docs.
Rate limit is per WORKSPACE, shared across all keys and across v1+v2, so a Zapier zap on v1 eats your v2 budget.
GET /api/v2/emails (reply/inbox polling) is limited to 20 req/min, far below the 6,000/min headline.
Credits are a SEPARATE subscription from Outreach; unused credits expire after 2 months on monthly plans, 1 year on annual.

10 moreShow fewer

No overage billing: hitting the email or uploaded-contact cap means upgrading or buying the $87 add-on, which only exists on Hypergrowth and above.
Webhooks auto-disable on delivery failures (status -1) with no published retry schedule; watch the status field and use the resume endpoint.
Terms prohibit any Data Resale Activity, including data enriched or verified through Instantly.
Custom reply labels are sent as the webhook event_type verbatim, so a receiver keyed on fixed event names will miss them.
API key is shown once and cannot be recovered.
Webhook event names in the developer guide are wrong for the API: use email_link_clicked (not link_clicked); auto_reply_received is not in the spec enum or the live event list.
MCP header auth returned 504 in our 2026-10-25 test while the URL-path key worked; if header auth fails, it is the server, not your key.
Bundle prices on the public pricing page (Scale $194, Agency $555) do not match the in-app Bundles tab (Scale $294/$265 annual with 10k credits, Agency $858/$772 with 45k credits); check the app before quoting.
No rate-limit headers are returned, so throttle client-side to 100 req/s and 6,000 req/min per workspace.
Campaigns now live under 'Engage' (/app/engage) in the app; clicking 'Cold Outreach Campaign' immediately creates a Draft campaign.

Who should use it

Use Instantly for: Cheapest entry to API-driven cold email: API v2 is on every paid Outreach plan from Growth ($47/mo), and in our test it also worked on the 14-day free trial
Look elsewhere for: Webhook-driven reply capture on the Growth plan: help center and pricing gate webhooks to Hypergrowth ($97/mo) and above (the Webhooks tab still shows 'Add Webhook' on the free trial; creating one was not tested)

If Instantly is not the answer

Other Email sending tools in this directory, each with its own review.

Outreach

Email sending

Best for integrating with an enterprise customer's existing Outreach org.

Outreach API review

Aimfox

LinkedIn outreach

From $40.83/moOfficial MCP

Best for multi-account LinkedIn outreach where you want to rent extra sender profiles natively.

Aimfox API review

Dripify

LinkedIn outreach

From $59/moOfficial MCP

Best for solo sellers or small teams running LinkedIn + email sequences from their own accounts.

Dripify API review

Compare Instantly with

Smartlead side by side

Before you build

Four things to settle first, each read off Instantly's own pages.

Confirm the API is on your planAPI access starts on the Outreach Growth plan. Free tier: 14-day free trial, no card.
Keep the key out of your codeAPI key. It is sent as: header: Authorization: Bearer <key>.
Design around the rate limitShared by API v1 and v2 across the whole workspace, even with multiple keys: max 100 requests/second and 6,000 requests/minute; exceeding either returns 429.
Know the catch before you scaleAPI v1 was deprecated on 19 Jan 2026; v2 needs a NEW key, v1 keys do not work on v2.

Want us to build it for you?

Tell us what you want Instantly to do in your stack. We will show you how we would wire it into your data, outbound or CRM, and what we would check first.

Book a call

See case studies

Read from instantly.ai/pricing.md, developer.instantly.ai/api-reference/introduction.md and developer.instantly.ai/getting-started/rate-limit.md. Verified 25 Oct 2026.

All 255 endpointsFor developers: method, path, what it does and what it costs.

Base URL: api.instantly.ai

Bulk and async: POST /api/v2/leads/add takes up to 1,000 leads per call; moves and warmup toggles run as background jobs polled via GET /api/v2/background-jobs/{id}.

Webhooks: Events: all_events, email_sent, email_opened, email_link_clicked, reply_received, email_bounced, lead_unsubscribed, campaign_completed, account_error, lead_neutral, lead_interested, lead_not_interested and 8 more. Retries: Webhook object carries status -1 = disabled due to delivery failures, plus a disabled timestamp; a resume endpoint and webhook-event logs exist. Retry schedule not documented.

Filter endpoints

255 endpoints

Method	Path	What it does	Cost
GET	`/api/v2/account-campaign-mappings/{email}`	Get campaigns associated with an email, Requires one of the following scopes: `account_campaign_mappings:read`, `account_campaign_mappings:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/accounts`	Create account, Requires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/accounts`	List account, Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/accounts/{email}`	Get account, Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/accounts/{email}`	Patch account, Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/accounts/{email}`	Delete account, Requires one of the following scopes: `accounts:delete`, `accounts:all`, `all:delete`, `all:all`	Not stated
POSTasync	`/api/v2/accounts/warmup/enable`	Enable warmup for accounts, Initiates a background job to enable warmup for the specified accounts. The response will contain the initial background job object. You can monitor the job's progress by polling the `GET: /api/v2/bac	Not stated
POSTasync	`/api/v2/accounts/warmup/disable`	Disable warmup for accounts, Initiates a background job to disable warmup for the specified accounts. The response will contain the initial background job object. You can monitor the job's progress by polling the `GET: /api/v2/ba	Not stated
POST	`/api/v2/accounts/warmup-analytics`	Get warmup analytics, Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/accounts/analytics/daily`	Get daily account analytics, Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts.	Not stated
POST	`/api/v2/accounts/pause`	Pause multiple accounts, Pauses up to 100 email accounts in the authenticated workspace. Each unique email is returned in either `paused_emails` or `failed_emails`. Requires one of the following scopes: `accounts:update`, `	Not stated
POST	`/api/v2/accounts/{email}/pause`	Pause an account, Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/accounts/{email}/resume`	Resume a paused account, Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/accounts/{email}/mark-fixed`	Mark an account as fixed, Sets the account to active and clears leftover error metadata such as status_message. Idempotent when the account is already active. Requires one of the following scopes: `accounts:update`, `account	Not stated
GET	`/api/v2/accounts/ctd/status`	Get custom tracking domain status, Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/accounts/test/vitals`	Test account vitals, Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/accounts/move`	Move accounts between workspaces, Move accounts between workspaces. IMPORTANT: this endpoint should be called ONLY with an ADMIN workspace API key, and b	Not stated
GET	`/api/v2/agent-items`	List AI agent items, Requires one of the following scopes: `all:read`, `all:all`	Not stated
POST	`/api/v2/agent-items/bulk-delete`	Bulk delete AI agent items, Requires one of the following scopes: `all:delete`, `all:all`	Not stated
POST	`/api/v2/api-keys`	Create api key, Requires one of the following scopes: `api_keys:create`, `api_keys:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/api-keys`	List api key, Requires one of the following scopes: `api_keys:read`, `api_keys:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/api-keys/{id}`	Delete api key, Requires one of the following scopes: `api_keys:delete`, `api_keys:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/audit-logs`	List audit log, Requires one of the following scopes: `audit_logs:read`, `audit_logs:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/background-jobs`	List background job, Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/background-jobs/{id}`	Get background job, Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/block-lists-entries`	Create block list entry, Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/block-lists-entries`	List block list entry, Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/block-lists-entries`	Delete all block list entries, Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/block-lists-entries/{id}`	Get block list entry, Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/block-lists-entries/{id}`	Patch block list entry, Requires one of the following scopes: `block_list_entries:update`, `block_list_entries:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/block-lists-entries/{id}`	Delete block list entry, Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/block-lists-entries/bulk-create`	Bulk create block list entry, Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`	Not stated
POST	`/api/v2/block-lists-entries/bulk-delete`	Bulk delete block list entry, Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/block-lists-entries/download`	Download all block list entries as CSV, Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/campaigns`	Create campaign, Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/campaigns`	List campaign, Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/campaigns/{id}/activate`	Activate(start), or resume a campaign, Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/campaigns/{id}/pause`	Stop(or pause) a campaign, Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/campaigns/{id}`	Get campaign, Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/campaigns/{id}`	Patch campaign, Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/campaigns/{id}`	Delete campaign, Requires one of the following scopes: `campaigns:delete`, `campaigns:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/campaigns/search-by-contact`	Search campaigns by lead email, Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/campaigns/analytics`	Get campaign(s) analytics, Get analytics for one or multiple campaigns. Specify the `id` field to get the analytics for a single campaign, or leave it empty to get the analytics for all campaigns	Not stated
GET	`/api/v2/campaigns/analytics/overview`	Get campaign(s) analytics overview, Get analytics overview for one or multiple campaigns. Specify the `id` field to get the analytics overview for a single campaign, or leave it empty to get the analytics overview for all campaigns. No	Not stated
GET	`/api/v2/campaigns/analytics/daily`	Get daily campaign analytics, Get campaign daily analytics	Not stated
GET	`/api/v2/campaigns/analytics/steps`	Get campaign steps analytics	Not stated
POST	`/api/v2/campaigns/{id}/share`	Share a campaign, Share a campaign. This allows other users to create new campaigns based on this campaign. The campaign is being shared for 7 days, after which you'll have to call this endpoint again if you want to en	Not stated
POST	`/api/v2/campaigns/{id}/from-export`	Create campaign from shared one, Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`	Not stated
POST	`/api/v2/campaigns/{id}/export`	Export campaign to JSON format, Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/campaigns/{id}/duplicate`	Duplicate campaign, Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/campaigns/count-launched`	Get launched campaigns count, Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/campaigns/{id}/variables`	Add campaign variables, Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/campaigns/{id}/sending-status`	Get campaign sending status, Returns sending status data explaining why a campaign may not be sending emails or is sending slower than expected. Note: Some fields may be missing when the campaign is out of schedule. Always-presen	Not stated
GET	`/api/v2/crm-actions/phone-numbers`	List phone numbers, Retrieve all phone numbers associated with the current organization. Requires one of the following scopes: `crm_actions:read`, `crm_actions:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/crm-actions/phone-numbers/{id}`	Delete phone number, Remove a phone number from the organization. Provider cleanup is retried automatically if delayed. Deleting an unknown or already removed number returns 404. A number that cannot be released because t	Not stated
GET	`/api/v2/custom-tag-mappings`	List custom tag mapping, Requires one of the following scopes: `custom_tag_mappings:read`, `custom_tag_mappings:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/custom-tags`	Create custom tag, Requires one of the following scopes: `custom_tags:create`, `custom_tags:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/custom-tags`	List custom tag, Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/custom-tags/{id}`	Get custom tag, Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/custom-tags/{id}`	Patch custom tag, Requires one of the following scopes: `custom_tags:update`, `custom_tags:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/custom-tags/{id}`	Delete custom tag, Requires one of the following scopes: `custom_tags:delete`, `custom_tags:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/custom-tags/toggle-resource`	Assign or unassign tags to resources, This can be used for both accounts and campaigns. Please check the `resource_type` field for more information.	Not stated
POST	`/api/v2/dfy-email-account-orders`	Place a DFY email account order, Place a Done-For-You (DFY) email account order for your workspace. Order types - `dfy`: Buy new DFY accounts on new custom domains. - `pre_warmed_up`: Buy available pre-warmed domains returned by	Not stated
GET	`/api/v2/dfy-email-account-orders`	List dfy email account order, Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/dfy-email-account-orders/domains/similar`	Generate similar available domains, This endpoint will generate a list of similar AND available domains based on the provided domain.. It will return a maximum number of 67 suggestions per extension (tld) requested.. All the returned do	Not stated
POST	`/api/v2/dfy-email-account-orders/domains/check`	Check domains availability, This endpoint will check the availability of the provided domains.. It will return a list of domains with their availability status.. The only supported extensions (tlds) are:.com,.org.. Only re	Not stated
POST	`/api/v2/dfy-email-account-orders/domains/pre-warmed-up-list`	Get pre-warmed up domains, This endpoint will return a list of pre-warmed up domains available for order. These domains are set up and configured in advance, allowing for quick deployment of email services. Use this end	Not stated
GET	`/api/v2/dfy-email-account-orders/accounts`	List DFY ordered email accounts, This endpoint will return a list of DFY email accounts ordered Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/dfy-email-account-orders/accounts/cancel`	Cancel dfy email accounts, This endpoint will cancel the DFY email accounts based on the provided email addresses. Cancelling permanently deletes all Unibox emails and conversations associated with the cancelled accounts. This	Not stated
GET	`/api/v2/domains/{domain}/forwarding`	Get domain forwarding, Returns the stored web forwarding configuration for a domain ordered through Instantly. All fields except `domain` are null when no forwarding is configured. Requires one of the following scopes: `d	Not stated
PUT	`/api/v2/domains/{domain}/forwarding`	Set domain forwarding, Sets web forwarding on a domain ordered through Instantly. The forwarding domain must be a valid domain different from the domain itself. Returns a conflict error while the domain order is still being	Not stated
DELETE	`/api/v2/domains/{domain}/forwarding`	Remove domain forwarding, Removes web forwarding from a domain ordered through Instantly. This operation is idempotent: removing forwarding from a domain that has none configured succeeds without changes. This request has a ra	Not stated
POST	`/api/v2/emails/test`	Send a test email, Send a preview/test email without creating an email entity in Unibox. Rate limit: 10 requests per minute per workspace. Requires one of the following scopes: `emails:create`, `emails:all`, `all:crea	Not stated
POST	`/api/v2/emails/reply`	Reply to an email, Send a reply to an email. This endpoint can be used to send an email only as a reply to an existing email. In order to reply to an email, please specify the `reyply_to_uuid` field, and your email will	Not stated
POST	`/api/v2/emails/forward`	Forward an email, Forward an existing email to another recipient. You must specify the `reply_to_uuid` field, which represents the `id` of an existing email returned by the `/emails` endpoints. By default only the prov	Not stated
GET	`/api/v2/emails`	List email, Rate Limit: This endpoint has a rate limit of 20 requests per minute, unlike other API endpoints. Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/emails/{id}`	Get email, Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/emails/{id}`	Patch email, Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/emails/{id}`	Delete email, Requires one of the following scopes: `emails:delete`, `emails:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/emails/unread/count`	Count unread emails, Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/emails/threads/{thread_id}/mark-as-read`	Mark all emails in a thread as read, Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-analytics`	List inbox placement analytics, Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-analytics/{id}`	Get inbox placement analytics, Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/inbox-placement-analytics/stats-by-test-id`	Retrieve inbox placement analytics stats by test id, Provides aggregated inbox, spam and category counts for specified test IDs Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:a	Not stated
POST	`/api/v2/inbox-placement-analytics/deliverability-insights`	Retrieve inbox placement analytics deliverability insights, Provides deliverability insights for a specific inbox placement test Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/inbox-placement-analytics/stats-by-date`	Get inbox placement analytics stats by date, Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests. Requires one of the following scopes: `inbox_placement_an	Not stated
GET	`/api/v2/inbox-placement-reports`	List inbox placement blacklist and spamassassin report, Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-reports/{id}`	Get inbox placement blacklist and spamassassin report, Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/inbox-placement-tests`	Create inbox placement test, Requires one of the following scopes: `inbox_placement_tests:create`, `inbox_placement_tests:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-tests`	List inbox placement test, Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-tests/{id}`	Get inbox placement test, Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/inbox-placement-tests/{id}`	Delete inbox placement test, Requires one of the following scopes: `inbox_placement_tests:delete`, `inbox_placement_tests:all`, `all:delete`, `all:all`	Not stated
PATCH	`/api/v2/inbox-placement-tests/{id}`	Patch inbox placement test, Requires one of the following scopes: `inbox_placement_tests:update`, `inbox_placement_tests:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/inbox-placement-tests/email-service-provider-options`	Get ESP options, Provides a list of available email service providers for inbox placement tests.	Not stated
POST	`/api/v2/lead-labels`	Create lead label, Requires one of the following scopes: `lead-labels:create`, `lead-labels:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/lead-labels`	List lead label, Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/lead-labels/{id}`	Get lead label, Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/lead-labels/{id}`	Patch lead label, Requires one of the following scopes: `lead-labels:update`, `lead-labels:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/lead-labels/{id}`	Delete lead label, Requires one of the following scopes: `lead-labels:delete`, `lead-labels:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/lead-labels/ai-reply-label`	Test AI reply label prediction, Returns the AI-predicted lead label for a reply text. This simulates how AI auto-tagging would label an incoming reply for testing custom labels and descriptions. Rate limit: 500 requests per 30 days	Not stated
POST	`/api/v2/lead-lists`	Create lead list, Requires one of the following scopes: `lead_lists:create`, `lead_lists:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/lead-lists`	List lead list, Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/lead-lists/{id}`	Get lead list, Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/lead-lists/{id}`	Patch lead list, Requires one of the following scopes: `lead_lists:update`, `lead_lists:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/lead-lists/{id}`	Delete lead list, Requires one of the following scopes: `lead_lists:delete`, `lead_lists:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/lead-lists/{id}/verification-stats`	Get verification statistics for a lead list	Not stated
POST	`/api/v2/leads`	Create lead, Requires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all`	Not stated
DELETE	`/api/v2/leads`	Delete leads in bulk, Delete multiple leads from a campaign or list based on filters. You must provide either `campaign_id` or `list_id`. Optionally filter by status or specific IDs. Requires one of the following scopes	Not stated
POST	`/api/v2/leads/list`	List leads, This endpoint is a POST endpoint, instead of GET - a deviation from the REST APIs standards we’re following because of the complex arguments it accepts, which would be too hard to express through quer	Not stated
GET	`/api/v2/leads/{id}`	Get lead, Requires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/leads/{id}`	Patch lead, Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/leads/{id}`	Delete lead, Requires one of the following scopes: `leads:delete`, `leads:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/leads/merge`	Merge two leads, Merge two leads Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/leads/update-interest-status`	Update the interest status of a lead	Not stated
POST	`/api/v2/leads/subsequence/remove`	Remove a lead from a subsequence, Remove a lead from a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/leads/bulk-assign`	Bulk assign leads to organization users	Not stated
POSTasync	`/api/v2/leads/move`	Move leads to a campaign or list, Move leads to a different campaign or list. This endpoint will return a background job that will process the move. The job will be processed in the background and the leads will be moved to the destin	Not stated
POST	`/api/v2/leads/subsequence/move`	Move a lead to a subsequence, Move a lead to a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/leads/add`	Add leads in bulk to a campaign or list, Adds up to 1000 leads to either a campaign or a list. You must provide a `campaign_id` or a `list_id`, but not both. The endpoint validates emails, checks against blocklists and existing leads. Requ	counts against uploaded-contacts limit; up to 1,000 leads per call
POST	`/api/v2/oauth/google/init`	Initialize google oauth, Creates an OAuth session and returns the Google authorization URL. The user should be redirected to auth_url to complete the OAuth flow. Poll the status endpoint to check for completion. **Special ra	Not stated
POST	`/api/v2/oauth/microsoft/init`	Initialize microsoft oauth, Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to auth_url to complete the OAuth flow. Poll the status endpoint to check for completion. **Special	Not stated
GET	`/api/v2/oauth/session/status/{sessionId}`	Get oauth session status, Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if somethi	Not stated
POST	`/api/v2/supersearch-enrichment/signal-keywords-facet`	Facet keywords for a signal category, Return the top matching keyword tokens for a given signal category and keyword field, aggregated from the last 90 days of signal data. Powers the Signals filter autocomplete in the Lead Finder. Unknow	Not stated
POST	`/api/v2/subsequences`	Create campaign subsequence, Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/subsequences`	List campaign subsequence, Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/subsequences/{id}/duplicate`	Duplicate a subsequence, Duplicate a subsequence with the same trigger conditions Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`	Not stated
POST	`/api/v2/subsequences/{id}/pause`	Pause a subsequence, Pause a subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/subsequences/{id}/resume`	Resume a paused subsequence, Resume a paused subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/subsequences/analytics`	Get subsequence analytics summary, Returns per-subsequence engagement totals (emails sent, unique opens, unique replies) for the subsequences of a campaign. Requires one of the following scopes: `subsequences:read`, `subsequences:all	Not stated
GET	`/api/v2/subsequences/{id}`	Get campaign subsequence, Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/subsequences/{id}`	Patch campaign subsequence, Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/subsequences/{id}`	Delete campaign subsequence, Requires one of the following scopes: `subsequences:delete`, `subsequences:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/subsequences/{id}/analytics/steps`	Get subsequence step and variant analytics, Returns engagement metrics grouped by zero-based step and variant for one subsequence. Results include only activity from the requested subsequence, excluding its parent campaign and sibling subsequen	Not stated
GET	`/api/v2/subsequences/{id}/sending-status`	Get subsequence sending status, Returns sending status data explaining why a subsequence may not be sending emails or is sending slower than expected. Note: Some fields may be missing when the campaign is out of schedule. Always-pre	Not stated
POSTasync	`/api/v2/email-verification`	Create email verification, If an email takes longer than 10 seconds to verify, the endpoint will return the status as `pending`. In that case, you may use the `/email-verification/:email` endpoint to check the status of the ver	0.25 credits per email (docs); measured 0.25 on our trial, credits 1000 -> 999.75
GET	`/api/v2/email-verification/{email}`	Check an email verification status, Requires one of the following scopes: `email_verifications:read`, `email_verifications:all`, `all:read`, `all:all`	free (status read; measured, no credits used)
GET	`/api/v2/webhook-events`	List webhook event, Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/webhook-events/{id}`	Get webhook event, Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/webhook-events/summary`	Get overview aggregates for webhook events, Get overview aggregates for webhook events including success/failure rates	Not stated
GET	`/api/v2/webhook-events/summary-by-date`	Get overview aggregates for webhook events by date, Get overview aggregates for webhook events by Date for charts	Not stated
GET	`/api/v2/webhooks`	List webhooks, List all webhooks for the workspace with optional filters	Not stated
POST	`/api/v2/webhooks`	Create webhook, Requires one of the following scopes: `webhooks:create`, `webhooks:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/webhooks/{id}`	Get webhook, Requires one of the following scopes: `webhooks:read`, `webhooks:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/webhooks/{id}`	Patch webhook, Requires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/webhooks/{id}`	Delete webhook, Requires one of the following scopes: `webhooks:delete`, `webhooks:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/webhooks/event-types`	List available event types, Get all available webhook event types including custom labels	Not stated
POST	`/api/v2/webhooks/{id}/test`	Test a webhook, Send a test payload to a webhook URL to verify it is working	Not stated
POST	`/api/v2/webhooks/{id}/resume`	Resume a webhook, Resume a webhook that was disabled due to repeated delivery failures Requires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/workspace-billing/plan-details`	Get workspace plan details, Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/workspace-billing/subscription-details`	Get workspace subscription details, Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/workspace-group-members`	Create workspace group member, This endpoint allows you to send an invitation for a sub workspace to join the admin workspace. The sub workspace will be added as a sub workspace of the admin workspace only if the sub workspace owne	Not stated
GET	`/api/v2/workspace-group-members`	List workspace group member, Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/workspace-group-members/{id}`	Get workspace group member, Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/workspace-group-members/{id}`	Delete workspace group member, Requires one of the following scopes: `workspace_group_members:delete`, `workspace_group_members:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/workspace-group-members/admin`	Get the current workspace admin workspace, Get the details of the admin workspace of the current workspace	Not stated
POST	`/api/v2/workspace-members`	Create workspace member, Requires one of the following scopes: `workspace_members:create`, `workspace_members:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/workspace-members`	List workspace member, Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/workspace-members/{id}`	Get workspace member, Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/workspace-members/{id}`	Patch workspace member, Requires one of the following scopes: `workspace_members:update`, `workspace_members:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/workspace-members/{id}`	Delete workspace member, Requires one of the following scopes: `workspace_members:delete`, `workspace_members:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/workspaces/current`	Get workspace, Get your current workspace details. Note that this endpoint doesn't require any parameters. It will return the workspace based on the API key sent in the headers. Requires one of the following scope	Not stated
PATCH	`/api/v2/workspaces/current`	Patch workspace, Update your current workspace details. Note that this endpoint doesn't require any parameters. It will update the workspace based on the API key sent in the headers. Requires one of the following sc	Not stated
POST	`/api/v2/workspaces/current/schedule-for-removal`	Schedule Current Workspace Removal, Schedule the current workspace to be removed in 24 hours. Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`	Not stated
DELETE	`/api/v2/workspaces/current/schedule-for-removal`	Cancel Current Workspace Removal, Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/workspaces/current/whitelabel-domain`	Set the agency domain for the workspace, Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`	Not stated
GET	`/api/v2/workspaces/current/whitelabel-domain`	Get organization verified agency domain information, Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`	Not stated
DELETE	`/api/v2/workspaces/current/whitelabel-domain`	Delete organization agency domain, Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/workspaces/current/change-owner`	Change workspace owner, Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/ai-agents/sales`	Create an AI Sales Agent, Create a new AI Sales Agent. Provide `type` and `input` to extract business details from a website or pitch deck, or skip the scrape by setting `memory_from_workspace` to true to copy the workspace bu	5 credits per lead the AI Sales Agent generates
GET	`/api/v2/ai-agents/sales`	List AI Sales Agents, List the AI Sales Agents of the workspace, newest first. Requires one of the following scopes: `ai_sdr:read`, `ai_agents:read`, `ai_sdr:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/sales/{id}`	Get an AI Sales Agent, Retrieve a single AI Sales Agent with its full configuration. Requires one of the following scopes: `ai_sdr:read`, `ai_sdr:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/sales/{id}`	Update an AI Sales Agent, Update an AI Sales Agent, including its configuration. Requires one of the following scopes: `ai_sdr:update`, `ai_sdr:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/ai-agents/sales/{id}`	Delete an AI Sales Agent, Delete an AI Sales Agent. Returns the core fields of the deleted agent. Fails with a conflict while campaigns are still linked to the agent. Requires one of the following scopes: `ai_sdr:delete`, `a	Not stated
GET	`/api/v2/ai-agents/sales/{id}/analytics`	Get AI Sales Agent analytics, Get daily analytics (leads found, emails sent, replies, opportunities, total email activity) merged across all campaigns of the AI Sales Agent. When `start_date` and `end_date` are omitted, the respon	Not stated
GET	`/api/v2/ai-agents/sales/{id}/opportunities/summary`	Get AI Sales Agent opportunity summary, Get aggregated opportunity counts by status and a per-campaign breakdown for all campaigns of the AI Sales Agent. When `start_date` and `end_date` are omitted, the response covers all-time data. Req	Not stated
GET	`/api/v2/ai-agents/sales/{id}/leads/{lead_id}/research`	Get research sources for an AI Sales Agent lead, Requires one of the following scopes: `ai_sdr:read`, `ai_sdr:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/sales/{id}/leads/activity/summary`	Get AI Sales Agent lead activity summary, Get aggregate counts and rates for lead activity across all campaigns of the AI Sales Agent. When `start_date` and `end_date` are omitted, the response covers all-time data. Requires one of the foll	Not stated
GET	`/api/v2/ai-agents/sales/{id}/leads/activity`	List AI Sales Agent lead activity, Get per-lead event history (emails sent, opens, replies, clicks, bounces, opportunity status) for all campaigns of the AI Sales Agent. Leads are ordered by email ascending and paginated with a cursor.	Not stated
GET	`/api/v2/ai-agents/sales/{id}/activities`	List AI Sales Agent activities, List all activities for the AI Sales Agent. Requires one of the following scopes: `ai_sdr:read`, `ai_sdr:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/ai-agents/sales/{id}/activities/{activity_id}/approve`	Approve an AI Sales Agent activity, Approve a pending AI Sales Agent activity action. Approving a `recommend_autopilot` activity turns on autopilot for the agent. Returns 404 when the activity does not exist or is not pending. Require	Not stated
POST	`/api/v2/ai-agents/sales/{id}/activities/{activity_id}/reject`	Reject an AI Sales Agent activity, Reject a pending AI Sales Agent activity action. Returns 404 when the activity does not exist or is not pending. Requires one of the following scopes: `ai_sdr:update`, `ai_sdr:all`, `all:update`, `a	Not stated
POST	`/api/v2/ai-agents/sales/{id}/activities/approve`	Approve multiple AI Sales Agent activities, Approve multiple pending AI Sales Agent activity actions. `recommend_autopilot` activities are skipped: approve them one at a time. Returns 404 when none of the activities exist or none are pending.	Not stated
POST	`/api/v2/ai-agents/sales/{id}/activities/reject`	Reject multiple AI Sales Agent activities, Reject multiple pending AI Sales Agent activity actions. `recommend_autopilot` activities are skipped: reject them one at a time. Returns 404 when none of the activities exist or none are pending. R	Not stated
GET	`/api/v2/ai-agents/sales/{id}/guidance-rules`	List AI Sales Agent guidance rules, List the guidance rules the AI Sales Agent follows when writing outreach. An agent has at most 10 rules, so the list is not paginated. Requires one of the following scopes: `ai_sdr:read`, `ai_sdr:al	Not stated
POST	`/api/v2/ai-agents/sales/{id}/guidance-rules`	Create an AI Sales Agent guidance rule, Add a guidance rule the AI Sales Agent must follow when writing outreach. An agent can have at most 10 rules. Rules are stored as a single list, so concurrent writes to the same agent are last-write-w	Not stated
PATCH	`/api/v2/ai-agents/sales/{id}/guidance-rules/{rule_id}`	Update an AI Sales Agent guidance rule, Update the title or content of a guidance rule. Rules are stored as a single list, so concurrent writes to the same agent are last-write-wins, serialize them client-side. Requires one of the follow	Not stated
DELETE	`/api/v2/ai-agents/sales/{id}/guidance-rules/{rule_id}`	Delete an AI Sales Agent guidance rule, Delete a guidance rule. Rule ids are positional, so the remaining rules re-index after a deletion, re-fetch the list before acting on another rule. Rules are stored as a single list, so concurrent wr	Not stated
POST	`/api/v2/ai-agents/inbox-manager`	Create an AI Inbox Manager, Create a new AI Inbox Manager with its configuration and optional initial guidance, saved together. The agent is created active. Including guidance also requires the guidance creation scope. Require	Not stated
GET	`/api/v2/ai-agents/inbox-manager`	List AI Inbox Managers, List the AI Inbox Managers of the workspace, newest first. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}`	Get an AI Inbox Manager, Retrieve a single AI Inbox Manager with its full configuration. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/inbox-manager/{id}`	Update an AI Inbox Manager, Update an AI Inbox Manager, including its configuration. Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/ai-agents/inbox-manager/{id}`	Delete an AI Inbox Manager, Delete an AI Inbox Manager. Returns the core fields of the deleted agent. Requires one of the following scopes: `ai_agents:delete`, `ai_agents:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/guidances`	List AI Inbox Manager guidances, List the guidances configured for an AI Inbox Manager. Requires one of the following scopes: `ai_agents:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/ai-agents/inbox-manager/{id}/guidances`	Create an AI Inbox Manager guidance, Create a guidance for an AI Inbox Manager. The BASICS category is an upsert: it carries tone/length options instead of an instruction, is always active, and an agent has at most one, creating a secon	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}`	Get an AI Inbox Manager guidance, Retrieve a single guidance of an AI Inbox Manager. Requires one of the following scopes: `ai_agents:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}`	Update an AI Inbox Manager guidance, Update a guidance of an AI Inbox Manager. BASICS guidances keep an empty instruction and stay active; a guidance cannot be changed to or from the BASICS category. Requires one of the following scope	Not stated
DELETE	`/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}`	Delete an AI Inbox Manager guidance, Delete a guidance of an AI Inbox Manager. Requires one of the following scopes: `ai_agents:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/replies`	List AI Inbox Manager replies, List the replies and follow-ups generated by an AI Inbox Manager, newest first. Requires one of the following scopes: `ai_sdr_replies:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/replies/{reply_id}`	Get an AI Inbox Manager reply, Retrieve a single reply generated by an AI Inbox Manager, including its HTML body. Requires one of the following scopes: `ai_sdr_replies:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/inbox-manager/{id}/replies/{reply_id}`	Update an AI Inbox Manager reply, Update a reply generated by an AI Inbox Manager: leave feedback on the reply or mark its pending action as handled. Requires one of the following scopes: `ai_sdr_replies:update`, `ai_agents:all`, `a	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/analytics/summary`	Get AI Inbox Manager analytics summary, Get aggregated analytics for an AI Inbox Manager over an optional date window. Requires one of the following scopes: `ai_inbox_manager_analytics:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/analytics/summary-by-date`	Get AI Inbox Manager analytics by date, Get daily analytics aggregates for an AI Inbox Manager over an optional date window. Requires one of the following scopes: `ai_inbox_manager_analytics:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/inbox-manager/{id}/analytics/activity`	List AI Inbox Manager activity, Get the paginated unified activity feed (replies, follow-ups and no-show recoveries) for an AI Inbox Manager, newest first. Requires one of the following scopes: `ai_inbox_manager_analytics:read`, `	Not stated
GET	`/api/v2/ai-agents/lead-finder`	List AI Lead Finder Agents, List the AI Lead Finder Agents of the workspace, newest first. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/ai-agents/lead-finder`	Create an AI Lead Finder Agent, Create an AI Lead Finder Agent that keeps a campaign topped up with fresh leads. The agent immediately runs its first check after creation. Requires one of the following scopes: `ai_agents:create`	Not stated
GET	`/api/v2/ai-agents/lead-finder/{id}`	Get an AI Lead Finder Agent, Retrieve a single AI Lead Finder Agent with its full configuration. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/lead-finder/{id}`	Update an AI Lead Finder Agent, Update an AI Lead Finder Agent's settings. `on_exhaustion: fallback` requires fallback filters, either in this request or already stored. Requires one of the following scopes: `ai_agents:update`, `a	Not stated
DELETE	`/api/v2/ai-agents/lead-finder/{id}`	Delete an AI Lead Finder Agent, Delete an AI Lead Finder Agent. Leads it already added to the campaign stay in the campaign. Requires one of the following scopes: `ai_agents:delete`, `ai_agents:all`, `all:delete`, `all:all`	Not stated
POST	`/api/v2/ai-agents/lead-finder/{id}/pause`	Pause an AI Lead Finder Agent, Pause an AI Lead Finder Agent. A paused agent stops topping up its campaign until resumed. Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/ai-agents/lead-finder/{id}/resume`	Resume an AI Lead Finder Agent, Resume a paused AI Lead Finder Agent. The agent immediately checks whether its campaign needs a top-up. Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`, `all	Not stated
GET	`/api/v2/ai-agents/lead-finder/{id}/stats`	Get AI Lead Finder Agent lifetime stats, Lifetime activity totals of an AI Lead Finder Agent. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/ai-agents/lead-finder/{id}/activities`	List AI Lead Finder Agent activities, List the activity events of an AI Lead Finder Agent, newest first. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/ai-agents/lead-finder/suggest-audience`	Suggest audiences from a campaign, Analyze the leads already in a campaign and suggest SuperSearch audiences that match them. Each suggestion returns a natural-language `query` plus store-format `filters`. Rate limited per workspace.	Not stated
GET	`/api/v2/ai-agents/lead-finder/enrichment-workflows`	List saved enrichment workflows, Reusable AI-enrichment chains saved by the workspace, ready to apply to a Lead Finder Agent. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/ai-agents/lead-finder/enrichment-workflows`	Save an enrichment workflow, Save an AI-enrichment chain as a named, workspace-wide reusable workflow. Requires one of the following scopes: `ai_agents:create`, `ai_agents:all`, `all:create`, `all:all`	Not stated
DELETE	`/api/v2/ai-agents/lead-finder/enrichment-workflows/{id}`	Delete a saved enrichment workflow, Delete a saved workflow. Agents that already loaded it keep their copied chain. Requires one of the following scopes: `ai_agents:delete`, `ai_agents:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/ai-agents/deliverability`	Get the default AI Deliverability Agent, Retrieve the workspace default AI Deliverability Agent. The `agent` field is `null` if one has not been deployed. Use the returned `agent.id` with endpoints that require an agent ID. Requires one of	Not stated
PATCH	`/api/v2/ai-agents/deliverability/settings`	Update the default AI Deliverability Agent settings, Update Slack notification settings for the workspace default AI Deliverability Agent. Set `slack` to `null` to disconnect Slack notifications. Requires one of the following scopes: `ai_agents:update	Not stated
GET	`/api/v2/ai-agents/deliverability/state`	Get the default AI Deliverability Agent state, Get the live state of the workspace default AI Deliverability Agent, including current activity, schedule, latest run summary, and activity feed. If no agent has been deployed, this endpoint returns a	Not stated
POST	`/api/v2/ai-agents/deliverability/feed-items/{id}/pause-affected-accounts`	Pause accounts affected by a deliverability recommendation, Pause active email accounts currently affected by the default agent's DNS-health or blocklist recommendation. The recommendation is revalidated before account statuses are changed. Calling this endpoi	Not stated
POST	`/api/v2/ai-agents/deliverability/feed-items/{id}/pause-campaign-sending`	Pause campaign sending for affected accounts, Pause campaign sending for 14 days on self-managed accounts affected by the default agent's bounce-health or warmup-score recommendation. Calling this endpoint for an already completed feed item is id	Not stated
POST	`/api/v2/ai-agents/deliverability/feed-items/{id}/complete`	Complete a Deliverability Agent feed item, Mark a supported pending recommendation complete after the default agent verifies that its underlying issue has been resolved. Currently, workspace-settings recommendations support manual completion.	Not stated
POST	`/api/v2/ai-agents/deliverability/run-now`	Run Deliverability Agent now, Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`, `all:all`	Not stated
POST	`/api/v2/ai-agents/deliverability/deploy`	Deploy the default AI Deliverability Agent, Create or reactivate the workspace default AI Deliverability Agent. This operation is idempotent when the agent is already active and schedules an initial cycle after deployment. Requires one of the	Not stated
GET	`/api/v2/ai-agents/deliverability/{id}`	Get an AI Deliverability Agent, Retrieve a single AI Deliverability Agent. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/ai-agents/deliverability/{id}`	Update an AI Deliverability Agent, Update an AI Deliverability Agent. Set `slack` to connect Slack notifications, or to null to disconnect them. Requires one of the following scopes: `ai_agents:update`, `ai_agents:all`, `all:update`	Not stated
DELETE	`/api/v2/ai-agents/deliverability/{id}`	Delete an AI Deliverability Agent, Delete an AI Deliverability Agent, removing its activity history and any queued runs. Returns the core fields of the deleted agent. Deploying again creates a fresh agent. Requires one of the followi	Not stated
GET	`/api/v2/ai-agents/deliverability/{id}/state`	Get AI Deliverability Agent state, Get the live state of an AI Deliverability Agent: current activity, schedule, latest run summary, and the activity feed. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all	Not stated
GET	`/api/v2/ai-agents/deliverability/{id}/feed-items`	List AI Deliverability Agent feed items, List the activity-feed items of an AI Deliverability Agent, newest first. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/supersearch-enrichment/ai`	Create AI enrichment, Create an AI enrichment for a resource (list or campaign) Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all`	~0.5+ credits per row (AI enrichment)
GET	`/api/v2/supersearch-enrichment/ai/{resource_id}/in-progress`	Get AI enrichment for resource, Get the AI enrichment for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists/recipes`	List company-list recipes, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists/sources`	List company-list sources, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists/filter-options`	Get remote filter options for a catalog-backed company-list filter	Not stated
POST	`/api/v2/supersearch-enrichment/company-lists`	Create a company list build, Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists`	List company lists, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists/{company_list_id}`	Get company-list status, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/supersearch-enrichment/company-lists/{company_list_id}`	Rename a terminal company list, Requires one of the following scopes: `supersearch_enrichments:update`, `supersearch_enrichments:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/supersearch-enrichment/company-lists/{company_list_id}`	Delete a terminal company list, Requires one of the following scopes: `supersearch_enrichments:delete`, `supersearch_enrichments:all`, `all:delete`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/company-lists/{company_list_id}/companies`	List company-list members, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/{resource_id}`	Get enrichment for resource, Get the enrichment for a specific resource	Not stated
POST	`/api/v2/supersearch-enrichment/`	Create an enrichment, Create an enrichment for a specific resource (list or campaign). This is the main endpoint for adding enrichments to resources. The enrichments are automatically run after creation. A `custom_flow` ty	Instantly credits per row per enrichment type (see enrich-leads-from-supersearch)
PATCH	`/api/v2/supersearch-enrichment/{resource_id}/settings`	Update enrichment settings for resource, Update auto-update and skip settings for a SuperSearch enrichment tied to a specific resource Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `	Not stated
POST	`/api/v2/supersearch-enrichment/enrich-leads-from-supersearch`	Enrich leads from supersearch, Add leads from SuperSearch to a list and enrich them. A list is automatically created if no list is provided.	Instantly credits per row per enrichment type: work email ~1.5 (1-2), full profile 0.5, AI enrichment ~0.5+, job listings/technologies/news/funding 0.5 each, verification 0.25
POST	`/api/v2/supersearch-enrichment/run`	Run enrichment for resource, Run all enrichments associated with a resource for a list of leads or for all the leads that haven't been enriched yet	Instantly credits per row per enrichment type (see enrich-leads-from-supersearch)
POST	`/api/v2/supersearch-enrichment/count-leads-from-supersearch`	Count leads from supersearch, Count the number of leads matching a SuperSearch query without enriching them. This endpoint is intended to estimate lead availability before running an enrichment. Requires one of the following sco	free (measured: no credits used; spec: counts "without enriching")
POST	`/api/v2/supersearch-enrichment/preview-leads-from-supersearch`	Preview leads from supersearch, Preview the leads matching a SuperSearch query without enriching them Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	free (measured: credits stayed 1000; emails not shown, 10 of 18 rows redacted)
GET	`/api/v2/supersearch-enrichment/history/{resource_id}`	Get enrichment history, Retrieve the enrichment history for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
GET	`/api/v2/supersearch-enrichment/integrations/providers`	Returns the full integration provider registry, Returns every data-provider integration with its available lookup actions, per-action credit cost, and whether the requesting workspace has connected its own provider account (isConnected). credential	free; returns creditCostPerAction per provider action and effectiveCostPerAction (0 when the workspace uses its own provider key)
POST	`/api/v2/supersearch-enrichment/integrations/run`	Run a single integration lookup action synchronously, Executes one lookup action for a single record with literal inputs and returns the provider payload inline, under the action's output column. Requires one of the following scopes: `supersearch_enric	effectiveCostPerAction of the chosen provider action (0 on the workspace's own provider key, otherwise creditCostPerAction); read it from GET /integrations/providers
GET	`/api/v2/supersearch-enrichment/saved-searches`	List saved searches, List the workspace's saved SuperSearch queries, newest first. Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
POST	`/api/v2/supersearch-enrichment/saved-searches`	Save a search, Save a SuperSearch query for reuse. `search_filters` uses the same shape as the count, preview and enrich endpoints. Requires one of the following scopes: `supersearch_enrichments:create`, `supersea	Not stated
GET	`/api/v2/supersearch-enrichment/saved-searches/{id}`	Get a saved search, Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`	Not stated
PATCH	`/api/v2/supersearch-enrichment/saved-searches/{id}`	Update a saved search, Rename a saved search and/or replace its filters. Requires one of the following scopes: `supersearch_enrichments:update`, `supersearch_enrichments:all`, `all:update`, `all:all`	Not stated
DELETE	`/api/v2/supersearch-enrichment/saved-searches/{id}`	Delete a saved search, Requires one of the following scopes: `supersearch_enrichments:delete`, `supersearch_enrichments:all`, `all:delete`, `all:all`	Not stated