Instantly
Connect to Instantly to manage outbound campaigns, leads, accounts, emails, analytics, tags, and webhooks.
Authentication
| Method | Kind | Status | Details |
|---|---|---|---|
| API Key | api_key | available | — |
Call a tool
import { createClient } from "@open-connector/sdk";const oc = createClient({ baseUrl: "https://api.openconnector.dev", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await oc.executeTool({ slug: "INSTANTLY_ACTIVATE_CAMPAIGN", connectedAccountId: "conn_...", arguments: { /* match this tool's input schema */ },});import Composio from "@composio/client";const composio = new Composio({ baseURL: "https://api.openconnector.dev/composio", apiKey: process.env.OPEN_CONNECTOR_API_KEY!,});const result = await composio.tools.execute("INSTANTLY_ACTIVATE_CAMPAIGN", { connected_account_id: "conn_...", arguments: { /* match this tool's input schema */ },});oc tools execute INSTANTLY_ACTIVATE_CAMPAIGN --data '{ }'Tool catalog
Available tools
170 callable operations
Activate(start), or resume a campaignINSTANTLY_ACTIVATE_CAMPAIGNRequires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Add campaign variablesINSTANTLY_ADD_VARIABLESRequires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Set the agency domain for the workspaceINSTANTLY_ADD_WORKSPACE_AGENCY_DOMAINRequires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Add leads in bulk to a campaign or listINSTANTLY_BULK_ADD_LEADSAdds 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. Requires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all`Connection
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. Requires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Bulk assign leads to organization usersINSTANTLY_BULK_ASSIGN_LEADSBulk assign leads to organization usersConnection
Bulk assign leads to organization users
Authentication
Connected account requiredTags
Delete leads in bulkINSTANTLY_BULK_DELETE_LEADSDelete 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: `leads:delete`, `leads:all`, `all:delete`, `all:all`Connection
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: `leads:delete`, `leads:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Cancel Current Workspace RemovalINSTANTLY_CANCEL_CURRENT_WORKSPACE_REMOVALRequires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Cancel dfy email accountsINSTANTLY_CANCEL_DFYEMAIL_ACCOUNTSThis 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 cannot be undone. Requires one of the following scopes: `dfy_email_account_orders:delete`, `dfy_email_account_orders:all`, `all:delete`, `all:all`Connection
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 cannot be undone. Requires one of the following scopes: `dfy_email_account_orders:delete`, `dfy_email_account_orders:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Change workspace ownerINSTANTLY_CHANGE_WORKSPACE_OWNERRequires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Check domains availabilityINSTANTLY_CHECK_DOMAINS_AVAILABILITYThis 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. . Domains containing trademarks of well-known companies are restricted and cannot be ordered. . Please do not abuse this endpoint and do not use it for anything other than checking availability before ordering a domain.. This request has a rate limit of 30 request per minute, or 900 requests per hour. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`Connection
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. . Domains containing trademarks of well-known companies are restricted and cannot be ordered. . Please do not abuse this endpoint and do not use it for anything other than checking availability before ordering a domain.. This request has a rate limit of 30 request per minute, or 900 requests per hour. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Check an email verification statusINSTANTLY_CHECK_VERIFICATION_STATUSRequires one of the following scopes: `email_verifications:read`, `email_verifications:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `email_verifications:read`, `email_verifications:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get launched campaigns countINSTANTLY_COUNT_LAUNCHEDRequires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Count leads from supersearchINSTANTLY_COUNT_LEADS_FROM_SUPERSEARCHCount 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 scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`Connection
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 scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Count unread emailsINSTANTLY_COUNT_UNREAD_EMAILSRequires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Create accountINSTANTLY_CREATE_ACCOUNTRequires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create AI enrichmentINSTANTLY_CREATE_AIENRICHMENTCreate 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`Connection
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`
Authentication
Connected account requiredTags
Create api keyINSTANTLY_CREATE_APIKEYRequires one of the following scopes: `api_keys:create`, `api_keys:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `api_keys:create`, `api_keys:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create block list entryINSTANTLY_CREATE_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create campaignINSTANTLY_CREATE_CAMPAIGNRequires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create campaign subsequenceINSTANTLY_CREATE_CAMPAIGN_SUBSEQUENCERequires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create custom tagINSTANTLY_CREATE_CUSTOM_TAGRequires one of the following scopes: `custom_tags:create`, `custom_tags:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `custom_tags:create`, `custom_tags:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Place a DFY email account orderINSTANTLY_CREATE_DFYEMAIL_ACCOUNT_ORDERPlace 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 `/dfy-email-account-orders/domains/pre-warmed-up-list`. - `extra_accounts`: Add mailboxes to domains you already ordered. All active accounts on a domain must use the same `email_provider`. **Provider limits and pricing** - `1` Google: up to 5 mailboxes per domain; per-mailbox monthly pricing. - `2` AirMail: up to 5 mailboxes per domain; per-mailbox monthly pricing. - `3` Microsoft/Outlook: exactly 50 mailboxes per new DFY domain; per-domain monthly pricing; extra-account orders are not supported. **Before ordering** - Regular DFY domains must use supported TLDs: .com, .org. - Check new-domain availability with `/dfy-email-account-orders/domains/check`. - Domains containing trademarks of well-known companies are restricted and cannot be ordered. - For pre-warmed orders, choose a domain from `/dfy-email-account-orders/domains/pre-warmed-up-list`; if none are available, use a regular `dfy` order instead. - The workspace must have an Outreach plan and a default payment method. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`Connection
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 `/dfy-email-account-orders/domains/pre-warmed-up-list`. - `extra_accounts`: Add mailboxes to domains you already ordered. All active accounts on a domain must use the same `email_provider`. **Provider limits and pricing** - `1` Google: up to 5 mailboxes per domain; per-mailbox monthly pricing. - `2` AirMail: up to 5 mailboxes per domain; per-mailbox monthly pricing. - `3` Microsoft/Outlook: exactly 50 mailboxes per new DFY domain; per-domain monthly pricing; extra-account orders are not supported. **Before ordering** - Regular DFY domains must use supported TLDs: .com, .org. - Check new-domain availability with `/dfy-email-account-orders/domains/check`. - Domains containing trademarks of well-known companies are restricted and cannot be ordered. - For pre-warmed orders, choose a domain from `/dfy-email-account-orders/domains/pre-warmed-up-list`; if none are available, use a regular `dfy` order instead. - The workspace must have an Outreach plan and a default payment method. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create email verificationINSTANTLY_CREATE_EMAIL_VERIFICATIONIf 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 verification job. Alternatively, you can send a `webhook_url` to receive the results instead of polling the status endpoint. Requires one of the following scopes: `email_verifications:create` Requires one of the following scopes: `email_verifications:create`, `email_verifications:all`, `all:create`, `all:all`Connection
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 verification job. Alternatively, you can send a `webhook_url` to receive the results instead of polling the status endpoint. Requires one of the following scopes: `email_verifications:create` Requires one of the following scopes: `email_verifications:create`, `email_verifications:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create campaign from shared oneINSTANTLY_CREATE_FROM_EXPORTRequires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create inbox placement testINSTANTLY_CREATE_INBOX_PLACEMENT_TESTRequires one of the following scopes: `inbox_placement_tests:create`, `inbox_placement_tests:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_tests:create`, `inbox_placement_tests:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create leadINSTANTLY_CREATE_LEADRequires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create lead labelINSTANTLY_CREATE_LEAD_LABELRequires one of the following scopes: `lead-labels:create`, `lead-labels:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `lead-labels:create`, `lead-labels:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create lead listINSTANTLY_CREATE_LEAD_LISTRequires one of the following scopes: `lead_lists:create`, `lead_lists:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `lead_lists:create`, `lead_lists:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create an enrichmentINSTANTLY_CREATE_SUPER_SEARCH_ENRICHMENTCreate 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.Connection
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.
Authentication
Connected account requiredTags
Create webhookINSTANTLY_CREATE_WEBHOOKRequires one of the following scopes: `webhooks:create`, `webhooks:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `webhooks:create`, `webhooks:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create workspace group memberINSTANTLY_CREATE_WORKSPACE_GROUP_MEMBERThis 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 owner accepts the invitation. Requires one of the following scopes: `workspace_group_members:create`, `workspace_group_members:all`, `all:create`, `all:all`Connection
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 owner accepts the invitation. Requires one of the following scopes: `workspace_group_members:create`, `workspace_group_members:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Create workspace memberINSTANTLY_CREATE_WORKSPACE_MEMBERRequires one of the following scopes: `workspace_members:create`, `workspace_members:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `workspace_members:create`, `workspace_members:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Bulk create block list entryINSTANTLY_CREATEBLUK_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Delete accountINSTANTLY_DELETE_ACCOUNTRequires one of the following scopes: `accounts:delete`, `accounts:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `accounts:delete`, `accounts:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete api keyINSTANTLY_DELETE_APIKEYRequires one of the following scopes: `api_keys:delete`, `api_keys:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `api_keys:delete`, `api_keys:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete block list entryINSTANTLY_DELETE_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete campaignINSTANTLY_DELETE_CAMPAIGNRequires one of the following scopes: `campaigns:delete`, `campaigns:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `campaigns:delete`, `campaigns:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete campaign subsequenceINSTANTLY_DELETE_CAMPAIGN_SUBSEQUENCERequires one of the following scopes: `subsequences:delete`, `subsequences:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `subsequences:delete`, `subsequences:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete custom tagINSTANTLY_DELETE_CUSTOM_TAGRequires one of the following scopes: `custom_tags:delete`, `custom_tags:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `custom_tags:delete`, `custom_tags:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete emailINSTANTLY_DELETE_EMAILRequires one of the following scopes: `emails:delete`, `emails:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `emails:delete`, `emails:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete inbox placement testINSTANTLY_DELETE_INBOX_PLACEMENT_TESTRequires one of the following scopes: `inbox_placement_tests:delete`, `inbox_placement_tests:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_tests:delete`, `inbox_placement_tests:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete leadINSTANTLY_DELETE_LEADRequires one of the following scopes: `leads:delete`, `leads:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `leads:delete`, `leads:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete lead labelINSTANTLY_DELETE_LEAD_LABELRequires one of the following scopes: `lead-labels:delete`, `lead-labels:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `lead-labels:delete`, `lead-labels:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete lead listINSTANTLY_DELETE_LEAD_LISTRequires one of the following scopes: `lead_lists:delete`, `lead_lists:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `lead_lists:delete`, `lead_lists:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete phone numberINSTANTLY_DELETE_PHONE_NUMBERDelete a specific phone number from the organization. Requires one of the following scopes: `crm_actions:delete`, `crm_actions:all`, `all:delete`, `all:all`Connection
Delete a specific phone number from the organization. Requires one of the following scopes: `crm_actions:delete`, `crm_actions:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete webhookINSTANTLY_DELETE_WEBHOOKRequires one of the following scopes: `webhooks:delete`, `webhooks:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `webhooks:delete`, `webhooks:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete organization agency domainINSTANTLY_DELETE_WORKSPACE_DOMAINRequires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Delete workspace group memberINSTANTLY_DELETE_WORKSPACE_GROUP_MEMBERRequires one of the following scopes: `workspace_group_members:delete`, `workspace_group_members:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `workspace_group_members:delete`, `workspace_group_members:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete workspace memberINSTANTLY_DELETE_WORKSPACE_MEMBERRequires one of the following scopes: `workspace_members:delete`, `workspace_members:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `workspace_members:delete`, `workspace_members:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Delete all block list entriesINSTANTLY_DELETEALL_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Bulk delete block list entryINSTANTLY_DELETEBULK_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Disable warmup for accountsINSTANTLY_DISABLE_WARMUP_FOR_ACCOUNTSInitiates 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/background-jobs/:id` endpoint.Connection
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/background-jobs/:id` endpoint.
Authentication
Connected account requiredTags
Download all block list entries as CSVINSTANTLY_DOWNLOAD_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Duplicate campaignINSTANTLY_DUPLICATERequires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`Connection
Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Duplicate a subsequenceINSTANTLY_DUPLICATE_SUBSEQUENCEDuplicate a subsequence with the same trigger conditions Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`Connection
Duplicate a subsequence with the same trigger conditions Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Enable warmup for accountsINSTANTLY_ENABLE_WARMUP_FOR_ACCOUNTSInitiates 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/background-jobs/:id` endpoint.Connection
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/background-jobs/:id` endpoint.
Authentication
Connected account requiredTags
Enrich leads from supersearchINSTANTLY_ENRICH_LEADS_FROM_SUPERSEARCHAdd leads from SuperSearch to a list and enrich them. A list is automatically created if no list is provided.Connection
Add leads from SuperSearch to a list and enrich them. A list is automatically created if no list is provided.
Authentication
Connected account requiredTags
Export campaign to JSON formatINSTANTLY_EXPORT_CAMPAIGNRequires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Forward an emailINSTANTLY_FORWARD_EMAILForward 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 provided body is sent. Set `include_original_body` to `true` to append the original email context. Requires one of the following scopes: `emails:create`, `emails:all`, `all:create`, `all:all`Connection
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 provided body is sent. Set `include_original_body` to `true` to append the original email context. Requires one of the following scopes: `emails:create`, `emails:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Generate similar available domainsINSTANTLY_GENERATE_SIMILAR_DOMAINSThis endpoint will generate a list of similar AND available domains based on the provided domain.. It will return a maximum number of 66 suggestions per extension (tld) requested.. All the returned domains will be available for order.. Domains containing trademarks of well-known companies are restricted and cannot be ordered. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`Connection
This endpoint will generate a list of similar AND available domains based on the provided domain.. It will return a maximum number of 66 suggestions per extension (tld) requested.. All the returned domains will be available for order.. Domains containing trademarks of well-known companies are restricted and cannot be ordered. Requires one of the following scopes: `dfy_email_account_orders:create`, `dfy_email_account_orders:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Get accountINSTANTLY_GET_ACCOUNTRequires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get campaigns associated with an emailINSTANTLY_GET_ACCOUNT_CAMPAIGN_MAPPINGRequires one of the following scopes: `account_campaign_mappings:read`, `account_campaign_mappings:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `account_campaign_mappings:read`, `account_campaign_mappings:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get the current workspace admin workspaceINSTANTLY_GET_ADMIN_WORKSPACE_GROUP_MEMBERGet the details of the admin workspace of the current workspaceConnection
Get the details of the admin workspace of the current workspace
Authentication
Connected account requiredTags
Get AI enrichment for resourceINSTANTLY_GET_AI_ENRICHMENT_FOR_RESOURCEGet the AI enrichment for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`Connection
Get the AI enrichment for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get background jobINSTANTLY_GET_BACKGROUND_JOBRequires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get block list entryINSTANTLY_GET_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get campaignINSTANTLY_GET_CAMPAIGNRequires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get campaign(s) analyticsINSTANTLY_GET_CAMPAIGN_ANALYTICSGet 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 campaignsConnection
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
Authentication
Connected account requiredTags
Get campaign(s) analytics overviewINSTANTLY_GET_CAMPAIGN_ANALYTICS_OVERVIEWGet 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. Note regarding the interest status totals (interested, meeting booked, meeting completed, closed): these are calculated based on the first occurrence of each event per contact by default. To change this behavior and calculate the totals based on all occurrences of the events, set the `expand_crm_events` parameter to `true`. Additionally, there is a 10 minute time window after you change a lead status in which the subsequent updates will NOT insert new analytics events to avoid duplicates from rapid status changes and avoid false inflation of the analytics numbers.Connection
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. Note regarding the interest status totals (interested, meeting booked, meeting completed, closed): these are calculated based on the first occurrence of each event per contact by default. To change this behavior and calculate the totals based on all occurrences of the events, set the `expand_crm_events` parameter to `true`. Additionally, there is a 10 minute time window after you change a lead status in which the subsequent updates will NOT insert new analytics events to avoid duplicates from rapid status changes and avoid false inflation of the analytics numbers.
Authentication
Connected account requiredTags
Get campaign sending statusINSTANTLY_GET_CAMPAIGN_SENDING_STATUSReturns 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-present fields: campaign_id, last_updated, status, issue_tracking. Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
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-present fields: campaign_id, last_updated, status, issue_tracking. Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get campaign steps analyticsINSTANTLY_GET_CAMPAIGN_STEPS_ANALYTICSGet campaign steps analyticsConnection
Get campaign steps analytics
Authentication
Connected account requiredTags
Get campaign subsequenceINSTANTLY_GET_CAMPAIGN_SUBSEQUENCERequires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get custom tracking domain statusINSTANTLY_GET_CTD_STATUSRequires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get custom tagINSTANTLY_GET_CUSTOM_TAGRequires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get daily account analyticsINSTANTLY_GET_DAILY_ACCOUNT_ANALYTICSGet daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts.Connection
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.
Authentication
Connected account requiredTags
Get daily campaign analyticsINSTANTLY_GET_DAILY_CAMPAIGN_ANALYTICSGet campaign daily analyticsConnection
Get campaign daily analytics
Authentication
Connected account requiredTags
Get emailINSTANTLY_GET_EMAILRequires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get enrichment for resourceINSTANTLY_GET_ENRICHMENT_FOR_RESOURCEGet the enrichment for a specific resourceConnection
Get the enrichment for a specific resource
Authentication
Connected account requiredTags
Get enrichment historyINSTANTLY_GET_ENRICHMENT_HISTORYRetrieve the enrichment history for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`Connection
Retrieve the enrichment history for a specific resource Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get inbox placement analyticsINSTANTLY_GET_INBOX_PLACEMENT_ANALYTICSRequires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Retrieve inbox placement analytics deliverability insightsINSTANTLY_GET_INBOX_PLACEMENT_ANALYTICS_DELIVERABILITY_INSIGHTSProvides 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`Connection
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`
Authentication
Connected account requiredTags
Get inbox placement analytics stats by dateINSTANTLY_GET_INBOX_PLACEMENT_ANALYTICS_STATS_BY_DATEProvides 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_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`Connection
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_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Retrieve inbox placement analytics stats by test idINSTANTLY_GET_INBOX_PLACEMENT_ANALYTICS_STATS_BY_TEST_IDProvides 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:all`Connection
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:all`
Authentication
Connected account requiredTags
Get inbox placement blacklist and spamassassin reportINSTANTLY_GET_INBOX_PLACEMENT_BLACKLIST_AND_SPAM_ASSASSIN_REPORTRequires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get inbox placement testINSTANTLY_GET_INBOX_PLACEMENT_TESTRequires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get ESP optionsINSTANTLY_GET_INBOX_PLACEMENT_TEST_ESPOPTIONSProvides a list of available email service providers for inbox placement tests.Connection
Provides a list of available email service providers for inbox placement tests.
Authentication
Connected account requiredTags
Get leadINSTANTLY_GET_LEADRequires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get lead labelINSTANTLY_GET_LEAD_LABELRequires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get lead listINSTANTLY_GET_LEAD_LISTRequires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get oauth session statusINSTANTLY_GET_OAUTH_SESSION_STATUSPoll 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 something went wrong. Sessions expire after 10 minutes.Connection
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 something went wrong. Sessions expire after 10 minutes.
Authentication
Connected account requiredTags
Get subsequence sending statusINSTANTLY_GET_SUBSEQUENCE_SENDING_STATUSReturns 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-present fields: campaign_id, subsequence_id, last_updated, status, issue_tracking. Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`Connection
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-present fields: campaign_id, subsequence_id, last_updated, status, issue_tracking. Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get verification statistics for a lead listINSTANTLY_GET_VERIFICATION_STATSGet verification statistics for a lead listConnection
Get verification statistics for a lead list
Authentication
Connected account requiredTags
Get warmup analyticsINSTANTLY_GET_WARMUP_ANALYTICSRequires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get webhookINSTANTLY_GET_WEBHOOKRequires one of the following scopes: `webhooks:read`, `webhooks:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `webhooks:read`, `webhooks:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get webhook eventINSTANTLY_GET_WEBHOOK_EVENTRequires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get overview aggregates for webhook eventsINSTANTLY_GET_WEBHOOK_EVENTS_SUMMARYGet overview aggregates for webhook events including success/failure ratesConnection
Get overview aggregates for webhook events including success/failure rates
Authentication
Connected account requiredTags
Get overview aggregates for webhook events by dateINSTANTLY_GET_WEBHOOK_EVENTS_SUMMARY_BY_DATEGet overview aggregates for webhook events by Date for chartsConnection
Get overview aggregates for webhook events by Date for charts
Authentication
Connected account requiredTags
Get workspaceINSTANTLY_GET_WORKSPACEGet 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 scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`Connection
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 scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get organization verified agency domain informationINSTANTLY_GET_WORKSPACE_DOMAIN_INFORequires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get workspace group memberINSTANTLY_GET_WORKSPACE_GROUP_MEMBERRequires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get workspace memberINSTANTLY_GET_WORKSPACE_MEMBERRequires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get workspace plan detailsINSTANTLY_GET_WORKSPACE_PLAN_DETAILSRequires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Get workspace subscription detailsINSTANTLY_GET_WORKSPACE_SUBSCRIPTION_DETAILSRequires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Initialize google oauthINSTANTLY_INIT_GOOGLE_OAUTHCreates 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 rate limits (stricter than the standard API rate limit) to comply with upstream Google rate limits:** - 75 requests per minute per workspace - 150 requests per minute per IP If Google's upstream OAuth service is temporarily unavailable, requests may return 503.Connection
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 rate limits (stricter than the standard API rate limit) to comply with upstream Google rate limits:** - 75 requests per minute per workspace - 150 requests per minute per IP If Google's upstream OAuth service is temporarily unavailable, requests may return 503.
Authentication
Connected account requiredTags
Initialize microsoft oauthINSTANTLY_INIT_MICROSOFT_OAUTHCreates 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 rate limits (stricter than the standard API rate limit) to comply with upstream Microsoft rate limits:** - 75 requests per minute per workspace - 150 requests per minute per IP If Microsoft's upstream OAuth service is temporarily unavailable, requests may return 503.Connection
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 rate limits (stricter than the standard API rate limit) to comply with upstream Microsoft rate limits:** - 75 requests per minute per workspace - 150 requests per minute per IP If Microsoft's upstream OAuth service is temporarily unavailable, requests may return 503.
Authentication
Connected account requiredTags
List accountINSTANTLY_LIST_ACCOUNTRequires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List api keyINSTANTLY_LIST_APIKEYRequires one of the following scopes: `api_keys:read`, `api_keys:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `api_keys:read`, `api_keys:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List audit logINSTANTLY_LIST_AUDIT_LOGRequires one of the following scopes: `audit_logs:read`, `audit_logs:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `audit_logs:read`, `audit_logs:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List background jobINSTANTLY_LIST_BACKGROUND_JOBRequires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List block list entryINSTANTLY_LIST_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List campaignINSTANTLY_LIST_CAMPAIGNRequires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List campaign subsequenceINSTANTLY_LIST_CAMPAIGN_SUBSEQUENCERequires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List custom tagINSTANTLY_LIST_CUSTOM_TAGRequires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List custom tag mappingINSTANTLY_LIST_CUSTOM_TAG_MAPPINGRequires one of the following scopes: `custom_tag_mappings:read`, `custom_tag_mappings:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `custom_tag_mappings:read`, `custom_tag_mappings:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List dfy email account orderINSTANTLY_LIST_DFYEMAIL_ACCOUNT_ORDERRequires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List DFY ordered email accountsINSTANTLY_LIST_DFYEMAIL_ACCOUNT_ORDERS_ACCOUNTSThis 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`Connection
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`
Authentication
Connected account requiredTags
List emailINSTANTLY_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`Connection
**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`
Authentication
Connected account requiredTags
List inbox placement analyticsINSTANTLY_LIST_INBOX_PLACEMENT_ANALYTICSRequires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List inbox placement blacklist and spamassassin reportINSTANTLY_LIST_INBOX_PLACEMENT_BLACKLIST_AND_SPAM_ASSASSIN_REPORTRequires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List inbox placement testINSTANTLY_LIST_INBOX_PLACEMENT_TESTRequires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List lead labelINSTANTLY_LIST_LEAD_LABELRequires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List lead listINSTANTLY_LIST_LEAD_LISTRequires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List leadsINSTANTLY_LIST_LEADSThis 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 query parameters. Results are ordered by each lead's `id` field in ascending order (or by `contact` when distinct_contacts is true) so clients can paginate chronologically by reusing the cursor returned in `next_starting_after`. Leads created on or after October 15, 2025 respect this chronological ordering; older records may appear out of sequence when sorted by ID. Requires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all`Connection
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 query parameters. Results are ordered by each lead's `id` field in ascending order (or by `contact` when distinct_contacts is true) so clients can paginate chronologically by reusing the cursor returned in `next_starting_after`. Leads created on or after October 15, 2025 respect this chronological ordering; older records may appear out of sequence when sorted by ID. Requires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List phone numbersINSTANTLY_LIST_PHONE_NUMBERSRetrieve all phone numbers associated with the current organization. Requires one of the following scopes: `crm_actions:read`, `crm_actions:all`, `all:read`, `all:all`Connection
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`
Authentication
Connected account requiredTags
List webhooksINSTANTLY_LIST_WEBHOOKList all webhooks for the workspace with optional filtersConnection
List all webhooks for the workspace with optional filters
Authentication
Connected account requiredTags
List webhook eventINSTANTLY_LIST_WEBHOOK_EVENTRequires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List available event typesINSTANTLY_LIST_WEBHOOK_EVENT_TYPESGet all available webhook event types including custom labelsConnection
Get all available webhook event types including custom labels
Authentication
Connected account requiredTags
List workspace group memberINSTANTLY_LIST_WORKSPACE_GROUP_MEMBERRequires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
List workspace memberINSTANTLY_LIST_WORKSPACE_MEMBERRequires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Mark an account as fixedINSTANTLY_MARK_ACCOUNT_FIXEDRequires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Mark all emails in a thread as readINSTANTLY_MARK_THREAD_AS_READRequires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Merge two leadsINSTANTLY_MERGE_LEADSMerge two leads Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`Connection
Merge two leads Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Move accounts between workspacesINSTANTLY_MOVE_ACCOUNTSMove accounts between workspaces. IMPORTANT: this endpoint should be called ONLY with an ADMIN workspace API key (check the workspace group docs: https://developer.instantly.ai/workspace-group), and both the source and destination workspaces must have the same admin workspace.Connection
Move accounts between workspaces. IMPORTANT: this endpoint should be called ONLY with an ADMIN workspace API key (check the workspace group docs: https://developer.instantly.ai/workspace-group), and both the source and destination workspaces must have the same admin workspace.
Authentication
Connected account requiredTags
Move a lead to a subsequenceINSTANTLY_MOVE_LEAD_TO_SUBSEQUENCEMove a lead to a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`Connection
Move a lead to a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Move leads to a campaign or listINSTANTLY_MOVE_LEADSMove 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 destination campaign or list. You can use the `/background-jobs/:id` endpoint to check the job status. Note: When using the `ids` parameter, you must also provide either `campaign` or `list_id` to specify which campaign or list to filter the leads from. Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`Connection
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 destination campaign or list. You can use the `/background-jobs/:id` endpoint to check the job status. Note: When using the `ids` parameter, you must also provide either `campaign` or `list_id` to specify which campaign or list to filter the leads from. Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch accountINSTANTLY_PATCH_ACCOUNTRequires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch block list entryINSTANTLY_PATCH_BLOCK_LIST_ENTRYRequires one of the following scopes: `block_list_entries:update`, `block_list_entries:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `block_list_entries:update`, `block_list_entries:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch campaignINSTANTLY_PATCH_CAMPAIGNRequires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch campaign subsequenceINSTANTLY_PATCH_CAMPAIGN_SUBSEQUENCERequires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch custom tagINSTANTLY_PATCH_CUSTOM_TAGRequires one of the following scopes: `custom_tags:update`, `custom_tags:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `custom_tags:update`, `custom_tags:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch emailINSTANTLY_PATCH_EMAILRequires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch inbox placement testINSTANTLY_PATCH_INBOX_PLACEMENT_TESTRequires one of the following scopes: `inbox_placement_tests:update`, `inbox_placement_tests:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `inbox_placement_tests:update`, `inbox_placement_tests:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch leadINSTANTLY_PATCH_LEADRequires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch lead labelINSTANTLY_PATCH_LEAD_LABELRequires one of the following scopes: `lead-labels:update`, `lead-labels:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `lead-labels:update`, `lead-labels:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch lead listINSTANTLY_PATCH_LEAD_LISTRequires one of the following scopes: `lead_lists:update`, `lead_lists:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `lead_lists:update`, `lead_lists:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch webhookINSTANTLY_PATCH_WEBHOOKRequires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch workspaceINSTANTLY_PATCH_WORKSPACEUpdate 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 scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`Connection
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 scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Patch workspace memberINSTANTLY_PATCH_WORKSPACE_MEMBERRequires one of the following scopes: `workspace_members:update`, `workspace_members:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `workspace_members:update`, `workspace_members:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Pause an accountINSTANTLY_PAUSE_ACCOUNTRequires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Stop(or pause) a campaignINSTANTLY_PAUSE_CAMPAIGNRequires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Pause a subsequenceINSTANTLY_PAUSE_SUBSEQUENCEPause a subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`Connection
Pause a subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Get pre-warmed up domainsINSTANTLY_PRE_WARMED_UP_DOMAINS_LISTThis endpoint will return a list of pre-warmed up domains available for order.<br/>These domains are set up and configured in advance, allowing for quick deployment of email services.<br/>Use this endpoint to retrieve available pre-warmed up domains before placing an order.<br/><br/><b>IMPORTANT: if the endpoint returns a list of empty domains - it's not a bug, please don't retry right away or report this as a bug - it simply means that there are no available pre-warmed up domains at the moment.</b> Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`Connection
This endpoint will return a list of pre-warmed up domains available for order.<br/>These domains are set up and configured in advance, allowing for quick deployment of email services.<br/>Use this endpoint to retrieve available pre-warmed up domains before placing an order.<br/><br/><b>IMPORTANT: if the endpoint returns a list of empty domains - it's not a bug, please don't retry right away or report this as a bug - it simply means that there are no available pre-warmed up domains at the moment.</b> Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Preview leads from supersearchINSTANTLY_PREVIEW_LEADS_FROM_SUPERSEARCHPreview 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`Connection
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`
Authentication
Connected account requiredTags
Remove a lead from a subsequenceINSTANTLY_REMOVE_LEAD_FROM_SUBSEQUENCERemove a lead from a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`Connection
Remove a lead from a subsequence Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Reply to an emailINSTANTLY_REPLY_TO_EMAILSend 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 be sent as a reply to that email. The `reyply_to_uuid` field represents the `id` field of an existing email, which is being returned to you in all the `/email` endpoints Requires one of the following scopes: `emails:create`, `emails:all`, `all:create`, `all:all`Connection
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 be sent as a reply to that email. The `reyply_to_uuid` field represents the `id` field of an existing email, which is being returned to you in all the `/email` endpoints Requires one of the following scopes: `emails:create`, `emails:all`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Resume a paused accountINSTANTLY_RESUME_ACCOUNTRequires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`Connection
Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Resume a paused subsequenceINSTANTLY_RESUME_SUBSEQUENCEResume a paused subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`Connection
Resume a paused subsequence Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all`
Authentication
Connected account requiredTags
Resume a webhookINSTANTLY_RESUME_WEBHOOKResume a webhook that was disabled due to repeated delivery failures Requires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all`Connection
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`
Authentication
Connected account requiredTags
Run enrichment for resourceINSTANTLY_RUN_ENRICHMENTRun all enrichments associated with a resource for a list of leads or for all the leads that haven't been enriched yetConnection
Run all enrichments associated with a resource for a list of leads or for all the leads that haven't been enriched yet
Authentication
Connected account requiredTags
Schedule Current Workspace RemovalINSTANTLY_SCHEDULE_CURRENT_WORKSPACE_REMOVALSchedule the current workspace to be removed in 24 hours. Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`Connection
Schedule the current workspace to be removed in 24 hours. Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`
Authentication
Connected account requiredTags
Search campaigns by lead emailINSTANTLY_SEARCH_BY_CONTACTRequires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Send a test emailINSTANTLY_SEND_TEST_EMAILSend 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:create`, `all:all`Connection
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:create`, `all:all`
Authentication
Connected account requiredTags
Share a campaignINSTANTLY_SHARE_CAMPAIGNShare 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 enable sharing on the campaignConnection
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 enable sharing on the campaign
Authentication
Connected account requiredTags
Facet keywords for a signal categoryINSTANTLY_SIGNAL_KEYWORDS_FACETReturn 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. Unknown (category, field) pairs return 400. Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`Connection
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. Unknown (category, field) pairs return 400. Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Test account vitalsINSTANTLY_TEST_ACCOUNT_VITALSRequires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`Connection
Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Test AI reply label predictionINSTANTLY_TEST_AI_REPLY_LABEL_LEAD_LABELSReturns 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 per workspace. This rate limit applies only to this testing endpoint; live reply processing does not use this limiter. Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`Connection
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 per workspace. This rate limit applies only to this testing endpoint; live reply processing does not use this limiter. Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all`
Authentication
Connected account requiredTags
Test a webhookINSTANTLY_TEST_WEBHOOKSend a test payload to a webhook URL to verify it is workingConnection
Send a test payload to a webhook URL to verify it is working
Authentication
Connected account requiredTags
Assign or unassign tags to resourcesINSTANTLY_TOGGLE_TAG_RESOURCEThis can be used for both accounts and campaigns. Please check the `resource_type` field for more information.Connection
This can be used for both accounts and campaigns. Please check the `resource_type` field for more information.
Authentication
Connected account requiredTags
Update enrichment settings for resourceINSTANTLY_UPDATE_ENRICHMENT_SETTINGS_FOR_RESOURCEUpdate 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`, `all:create`, `all:all`Connection
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`, `all:create`, `all:all`
Authentication
Connected account requiredTags
Update the interest status of a leadINSTANTLY_UPDATE_LEAD_INTEREST_STATUSUpdate the interest status of a leadConnection
Update the interest status of a lead
Authentication
Connected account requiredTags