Reference

Create API Key

Generates a new API key with custom permission levels to securely connect your Instantly account to third-party tools and automation platforms. Use this when you need to grant programmatic access to specific features without sharing your main credentials.

Delete API Key

Removes an API key from your account to revoke access and improve security. Use this when you no longer need a key or want to rotate credentials for safety.

Get API Keys

Retrieve a complete list of API keys for your organization, including their names, scopes, and creation timestamps. This helps you manage and audit all active integrations and third-party connections.

List API Keys (Deprecated)

Retrieves all API keys associated with your Instantly account, with optional pagination support to manage multiple keys.

Get Campaign Analytics

Retrieve performance metrics and analytics data for your email campaigns to understand engagement, delivery, and conversion results. Use this to track campaign effectiveness and make data-driven decisions about your outreach strategies.

Get Accounts Warmup Analytics

Retrieve warmup analytics and health scores for your email accounts to monitor their deliverability and engagement performance. This helps ensure your emails reach inboxes instead of spam folders.

Get Campaign Steps Analytics

Retrieve detailed performance metrics for each step in your email campaign sequences, including data broken down by campaign variants and steps. This helps you identify which parts of your campaigns are working best and where prospects are dropping off.

Get Campaigns Analytics Overview

Retrieve comprehensive performance metrics for your email campaigns including leads generated, emails sent, reply rates, open rates, clicks, and CRM events in a single overview.

Get Daily Account Analytics

Retrieve daily email performance metrics for your accounts, showing how many emails were sent each day to track outreach activity and engagement patterns.

Get Daily Campaign Analytics

Retrieves daily performance metrics for your campaigns, allowing you to track how each day's efforts are performing in terms of engagement, conversions, and other key metrics.

Get Workspace Billing Plan Details

Retrieve detailed information about your current workspace billing plan, including usage limits and features across all Instantly services like lead finder, verification, CRM, and email deliverability tools.

Create Block List Entry

Prevent campaigns from reaching specific email addresses or entire domains by adding them to your block list, ensuring you don't contact invalid, problematic, or opted-out recipients.

Delete Block List Entry

Removes a specific email address or domain from your block list, allowing you to resume communication with that contact.

Get Block List Entry

Retrieve detailed information about a specific blocked email or domain entry using its ID, allowing you to verify blocking status and view block details.

List Block List Entries

Retrieve all blocked email addresses or domains from your blocklist to review what contacts you've excluded from communications. Use this to audit your blocklist, find accidentally blocked contacts, or verify domain restrictions.

Update Block List Entry

Modify existing blocked email addresses or domains in your contact list to manage communication restrictions. Use this when you need to update who you're blocking from reaching you.

Activate Campaign

Starts sending emails from a paused or inactive campaign to your leads based on your configured sequences and schedule. This lets you resume outreach efforts after making updates or pauses.

Create Campaign

Launch a new email or outreach campaign with your prepared messaging and target audience list. Use this when you're ready to deploy a coordinated marketing or sales effort.

Get Campaign Sending Status

Check the current delivery status and health of your email campaigns, including diagnostics about why emails might be delayed or not sending.

List Campaigns

Retrieve all your email campaigns with optional filtering and pagination to organize and review your outreach efforts.

Count Launched Campaigns

Get the total number of campaigns you've launched in your workspace to track your outreach activity and campaign volume over time.

Delete Campaign

Permanently removes a campaign from your Instantly account, freeing up resources and cleaning up your marketing workspace.

Duplicate Campaign

Creates an exact copy of an existing campaign with all its settings and configuration, allowing you to quickly launch similar campaigns without manual setup.

Export Campaign

Downloads your complete campaign configuration and data in JSON format, allowing you to safely store campaign details or transfer them to another system.

Get Account Campaign Mappings

Retrieves all campaigns that are currently linked to a specific email account, helping you understand which outreach efforts are connected to that address.

Get Campaign

Retrieve detailed information about a specific campaign including its configuration, settings, and performance metrics to understand your marketing efforts.

Import Campaign from Export

Recreate your email or outreach campaigns by importing previously exported campaign configurations, allowing you to quickly restore or duplicate campaigns without rebuilding them from scratch.

Pause Campaign

Temporarily halts all sending operations for an active campaign without deleting it, allowing you to make adjustments or stop communications when needed.

Search Campaigns by Lead Email

Find which email campaigns a specific lead is enrolled in by searching using their email address. This helps you understand a prospect's engagement history and current campaign status at a glance.

Share Campaign

Instantly share a campaign template with team members or collaborators for a 7-day period, allowing them to view and access the campaign details without permanent ownership changes.

Update Campaign

Modify campaign details like name, description, goals, and target audience after the campaign has been created. This lets you adjust your marketing strategy based on performance or changing business needs.

Create Inbox Placement Test

Tests how your emails perform across different email providers to ensure they reach inboxes instead of spam folders. This helps you optimize your email campaigns before sending to your full list.

Get Inbox Placement Analytics Stats By Date

Retrieve daily analytics showing how your test emails landed across inbox, spam, and folder categories over time. Use this to monitor your email deliverability trends and identify potential issues with your sender reputation.

Get Inbox Placement Analytics Stats By Test ID

Retrieve detailed inbox placement statistics for your email tests to see how many messages landed in inbox versus spam across different email providers and regions. Use this to measure email deliverability performance and identify delivery issues before sending campaigns to your full list.

Get Inbox Placement Deliverability Insights

Retrieve detailed analytics on where your emails are landing (inbox, spam, categories) with percentage breakdowns and optional comparisons to previous periods, helping you understand email deliverability performance.

Get Inbox Placement Test

Retrieves detailed results from an inbox placement test, showing whether your emails landed in the inbox or spam folder across different email providers. This helps you understand your email deliverability performance before sending campaigns.

List Inbox Placement Blacklist & SpamAssassin Reports

Retrieve spam and blacklist analytics to see if your emails are being flagged or blocked by email providers, helping you identify deliverability issues before sending campaigns.

List Inbox Placement Tests

Retrieve a paginated list of your inbox placement tests to monitor email deliverability and track how your campaigns land in recipient inboxes. This helps you identify delivery issues and optimize your email strategy.

Update Inbox Placement Test

Modify an existing inbox placement test to update its configuration, settings, or parameters. Use this when you need to adjust test details after initial creation to improve email deliverability monitoring.

Delete Whitelabel Domain

Removes a custom branded domain from your workspace, reverting to the default domain for your email communications and customer interactions.

Set Whitelabel Domain

Configure a custom domain for your workspace to display your own branding instead of the platform's default domain, creating a more professional and personalized client experience.

Check Custom Tracking Domain Status

Verify the setup and health of your custom email tracking domain by checking its SSL configuration and DNS records. This helps ensure your email tracking is properly configured and working reliably.

Check DFY Email Account Order Domains

Validates whether domains are available and eligible for DFY email account orders before committing to a purchase. This ensures you don't waste time or money on unavailable domains.

Get DFY Email Account Order Accounts

Retrieves a list of email accounts from your Done-For-You email account orders, helping you manage and track the accounts you've purchased or set up through the service.

Get Email Service Provider Options

Retrieve available email service provider options to understand which inbox platforms you can test your email deliverability against. This helps you validate that your campaigns reach the inbox across major email clients.

Get Similar DFY Email Account Order Domains

Find available alternative domain names similar to one you specify, helping you secure a domain when your first choice isn't available. Useful for quickly finding backup domain options for email accounts and business branding.

List DFY Email Account Orders

Retrieves your DFY (Done-For-You) email account orders with pagination support, allowing you to view all your outsourced email setup purchases and their details.

List Email Accounts

Retrieve all email accounts connected to your Instantly profile so you can manage multiple inboxes and campaigns from a single dashboard.

List Pre-warmed Up DFY Domains

Retrieve a list of pre-warmed domains that are ready to use for email account orders, with all authentication and warmup steps already completed.

Test Accounts Vitals

Verify that email accounts are properly connected and functioning by testing IMAP/SMTP connectivity and checking account health status. This helps ensure your email infrastructure is ready for reliable communication and integrations.

Count Unread Emails

Retrieves the count of unread emails in your inbox to help you stay on top of incoming messages and prioritize your response workflow.

List Emails

Retrieve your stored emails with optional filtering and pagination to find specific messages quickly. Use this to access your email history and identify leads or prospects you've communicated with.

Mark Thread As Read

Marks all emails in a specific thread as read to help you track which conversations you've processed and keep your inbox organized. This ensures you don't lose track of important customer discussions you've already reviewed.

Create AI Enrichment

Automatically enhance your campaign or lead list with AI-powered insights like firmographics, technographics, and behavioral data to improve targeting and personalization.

Create SuperSearch Enrichment

Automatically enriches your leads with verified contact information, professional profiles, and company details in bulk. This helps you build more complete prospect records for better targeting and outreach.

Get SuperSearch Enrichment

Retrieve enrichment configuration, status, and progress details for your contact lists or campaigns to monitor data enhancement activities. Use this to check whether enrichment is complete and review how your contact information has been enhanced.

Patch SuperSearch Enrichment Settings

Update enrichment settings for your lead lists to control how new contact information is automatically gathered and applied, including deciding whether to overwrite existing data and skip incomplete records.

Run SuperSearch Enrichment

Automatically enriches lead data by filling in missing contact information, company details, and other relevant attributes for your prospect lists. This saves time by gathering comprehensive information about potential customers without manual research.

Create Lead Label

Create custom labels to organize and categorize your leads based on their interests, status, or other business criteria. This helps you segment your prospect database for targeted follow-up and better pipeline management.

Delete Lead Label

Remove custom labels from leads to maintain an organized categorization system as your business needs evolve. Use this when labels become outdated or need to be consolidated.

Get Lead Label

Retrieve details about a specific lead label by its ID to understand how your leads are categorized and organized. Use this when you need to verify label properties or fetch label information for reporting and lead management workflows.

Get Lead Label by ID (Deprecated)

Retrieve details about a specific lead label to understand how individual leads are categorized and organized in your system. This helps you verify label configurations and manage your lead organization structure.

Update Lead Label

Modify custom labels assigned to leads to keep your contact database organized and accurately categorized for better follow-up prioritization.

Add Leads in Bulk

Import multiple leads at once into your Instantly campaign or list, saving time on manual data entry and enabling you to launch outreach campaigns faster.

List Leads

Retrieve your leads from Instantly with flexible filtering options to find specific prospects by search terms, status, or other criteria. Use this to quickly access your lead database and organize outreach campaigns.

Update Lead

Modify and refresh your lead information to keep your prospect database current and accurate. Use this when you need to update contact details, engagement status, or other lead attributes after initial creation.

Bulk Assign Leads

Assign multiple leads at once to different team members in your organization, streamlining the distribution of sales opportunities without manual one-by-one assignment.

Count Leads from SuperSearch

Counts how many leads match your search criteria so you can verify your targeting before processing a batch enrichment job. This helps you estimate the scope of your outreach campaigns without committing resources upfront.

Create Lead

Adds a new prospect to your outreach campaigns so you can start building relationships and tracking potential customers.

Create Lead List

Organize and group your leads into dedicated lists before launching email campaigns or outreach efforts. This helps you segment your audience and manage different prospect groups efficiently.

Delete Lead

Removes a specific lead from your database when you no longer need to track them. Use this to clean up duplicate, invalid, or no-longer-relevant prospect records.

Delete Lead List

Remove a specific lead list from your Instantly account when you no longer need it. This helps you keep your lead management clean and organized by deleting outdated or duplicate lists.

Get CRM Phone Numbers

Retrieve all phone numbers configured in your CRM system to see which contact methods are available for outreach and communication. This helps you manage and organize the phone resources your business uses for customer interactions.

Get Lead

Retrieve complete information about a specific lead using its unique identifier, allowing you to access all stored details like contact info, interaction history, and lead status.

Get Lead List

Retrieve detailed information about a specific lead list using its ID, including metadata and list settings. Use this to access and verify lead list configuration before running campaigns or analyzing list performance.

List Lead Lists

Retrieve all your organized lead lists with filtering and pagination options to quickly find the specific groups of prospects you need to work with.

Merge Leads

Combines multiple lead records into a single unified profile, eliminating duplicates and consolidating all associated information into one clean record.

Move Leads

Transfer leads between campaigns to reorganize your prospect pipeline and ensure contacts are nurtured under the most relevant marketing efforts.

Update Lead Interest Status

Update a lead's interest status to track engagement level and prioritize follow-up actions based on their current interest in your offering.

Update Lead List

Modify the details and settings of an existing lead list to keep your prospect information organized and up-to-date. This helps you maintain accurate targeting criteria and contact segments for your outreach campaigns.

Create Subsequence

Automatically triggers follow-up email sequences when leads meet specific conditions like status changes, replies, or keywords. This enables you to nurture prospects through personalized paths without manual intervention.

Delete Subsequence

Permanently remove an automated follow-up sequence from your campaign when it's no longer needed or was set up incorrectly. This helps you clean up your automation workflows and prevent unwanted messages from being sent.

Duplicate Subsequence

Create a copy of an existing subsequence with all its trigger conditions and messaging intact, allowing you to reuse proven automation sequences across different campaigns without rebuilding from scratch.

Get Subsequence

Retrieve detailed information about a specific follow-up sequence in your CRM to review its settings, steps, and configuration. This helps you understand exactly how your automated sequences are structured before running or modifying them.

Pause Subsequence

Temporarily halt an active campaign subsequence without losing progress, allowing you to pause follow-ups and resume them later when ready.

Remove Lead From Subsequence

Stops a lead from receiving emails in a specific campaign subsequence, allowing you to pause or cancel outreach to a prospect without removing them from your CRM.

Resume Subsequence

Restart a paused follow-up sequence in your campaign to continue nurturing leads or customers where you left off.

Update Subsequence

Modify the settings of a campaign subsequence, including its name, timing, and CRM status triggers to fine-tune how your automated email sequences behave.

Create Custom Tag

Create a new custom tag to organize and categorize your accounts and campaigns, making it easier to segment and manage your contacts based on business needs.

Delete Custom Tag

Removes a custom tag from your CRM system, allowing you to clean up outdated or unused organizational labels that no longer serve your business needs.

Get Custom Tag

Retrieve details about a specific custom tag used to organize and categorize your accounts and campaigns in your CRM system.

Get Custom Tag Mappings

Retrieve all custom tag mappings to see which tags are connected to your campaigns, email accounts, and other resources. Use this to understand your current tag organization and resource associations.

List Custom Tags

Retrieve all custom tags you've created in your system with optional filtering and pagination to organize and manage your contact categories.

Update Custom Tag

Modify an existing custom tag's label or description to keep your account and campaign organization system current and relevant.

Check Email Verification Status

Retrieves the current verification status of an email address you've submitted for validation, allowing you to determine if an email is legitimate and active. This helps maintain clean contact lists and avoid bouncing emails.

Get Lead List Verification Stats

Retrieve verification statistics for a lead list to see how many contacts are verified, invalid, or pending review. Use this to quickly assess data quality and determine which leads are ready for outreach.

Verify Email

Checks whether an email address is valid and deliverable before you send messages to it, helping you avoid wasted effort on bad addresses. This saves you from bounces and protects your sender reputation.

Disable Account Warmup

Stop the email warming process for your account(s) to immediately begin sending campaigns or messages without further delays.

Enable Account Warmup

Activates the email warm-up process for your accounts to gradually build sender reputation and improve email delivery rates. This prepares your email infrastructure for higher-volume campaigns by establishing trust with email providers.

Create Webhook

Set up a webhook to automatically receive real-time notifications from Instantly when important events occur, enabling you to instantly react to email campaigns, lead interactions, and customer activities without manual checking.

Delete Webhook

Remove a webhook from your Instantly account when you no longer need real-time notifications for specific events. This helps clean up your integrations and stop unnecessary data transfers.

Get Webhook

Retrieve the complete configuration details of a specific webhook to verify its settings, URL, and subscription status. This helps you confirm that your automation is properly connected and monitoring the right events.

Get Webhook Event

Retrieve the complete details and payload of a specific webhook event to inspect what data was sent and troubleshoot integration issues. Use this when you need to verify that customer actions or system events were properly captured and processed.

Get Webhook Event Types

Retrieve all available webhook event types that can trigger automated notifications from your CRM system. This helps you understand which business events you can monitor and automate responses for.

Get Webhook Events Summary

Retrieve aggregated webhook delivery metrics including success and failure statistics for a specified date range, helping you monitor the health and reliability of your data integrations.

Get Webhook Events Summary By Date

Retrieve aggregated webhook event statistics organized by date to monitor email campaign activity and integration performance over time. This helps you understand the volume and patterns of webhook events your system is processing.

List Webhook Events

View all webhook events your Instantly account has received, with options to filter and paginate through the results. This helps you monitor data synchronization and verify that important events have been properly captured.

List Webhooks

Retrieve all configured webhooks to see which automated notifications and integrations are currently active in your system. This helps you manage and troubleshoot data synchronization across your connected tools.

Patch Webhook

Update an existing webhook's configuration, such as the target URL, event type, or name, to change how your CRM notifies you of important events. This lets you adapt your integrations without recreating webhooks from scratch.

Test Webhook

Send a test message to your webhook to verify it's receiving data correctly and responding as expected. This helps you confirm your webhook configuration is working before relying on it for important business processes.

Add Workspace Member

Invite a new team member to your workspace by specifying their email address and assigning them a role with appropriate permissions.

Get Admin Workspace Group Member

Retrieve administrative details about your workspace group membership, including workspace identifiers and membership status. Use this to verify your access level and workspace configuration within your Instantly account.

Get Audit Logs

Retrieve detailed records of all system activities and changes made within your account to track who did what and when. This helps you maintain accountability and understand the history of modifications to your data.

Get Current Workspace

Retrieves the details of your current workspace including plan information, owner details, and organization settings to help you manage your account and understand your current subscription level.

Get Workspace Member by ID

Retrieves detailed information about a specific member in your workspace, including their user profile and associated data. Use this when you need to look up individual team member details for verification or management purposes.

Toggle Resource

Quickly add or remove custom tags from your accounts and campaigns to organize and categorize your CRM data. This helps you keep your customer information organized and easy to find based on your business needs.

Update Current Workspace

Modify your workspace settings including the name and logo to keep your business branding consistent and up-to-date. This ensures your client-facing workspace reflects your current company identity.