# Instantly API Docs ## Docs - [Create account](https://developer.instantly.ai/api-reference/account/create-account.md): Requires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all` - [Delete account](https://developer.instantly.ai/api-reference/account/delete-account.md): Requires one of the following scopes: `accounts:delete`, `accounts:all`, `all:delete`, `all:all` - [Disable warmup for accounts](https://developer.instantly.ai/api-reference/account/disable-warmup-for-accounts.md): 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. - [Enable warmup for accounts](https://developer.instantly.ai/api-reference/account/enable-warmup-for-accounts.md): 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. - [Get account](https://developer.instantly.ai/api-reference/account/get-account.md): Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` - [Get custom tracking domain status](https://developer.instantly.ai/api-reference/account/get-custom-tracking-domain-status.md): Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` - [Get daily account analytics](https://developer.instantly.ai/api-reference/account/get-daily-account-analytics.md): 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. - [Get warmup analytics](https://developer.instantly.ai/api-reference/account/get-warmup-analytics.md): Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` - [List account](https://developer.instantly.ai/api-reference/account/list-account.md): Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` - [Mark an account as fixed](https://developer.instantly.ai/api-reference/account/mark-an-account-as-fixed.md): Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all` - [Move accounts between workspaces](https://developer.instantly.ai/api-reference/account/move-accounts-between-workspaces.md): 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. - [Patch account](https://developer.instantly.ai/api-reference/account/patch-account.md): Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all` - [Pause an account](https://developer.instantly.ai/api-reference/account/pause-an-account.md): Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all` - [Resume a paused account](https://developer.instantly.ai/api-reference/account/resume-a-paused-account.md): Requires one of the following scopes: `accounts:update`, `accounts:all`, `all:update`, `all:all` - [Test account vitals](https://developer.instantly.ai/api-reference/account/test-account-vitals.md): Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` - [Get campaigns associated with an email](https://developer.instantly.ai/api-reference/accountcampaignmapping/get-campaigns-associated-with-an-email.md): Requires one of the following scopes: `account_campaign_mappings:read`, `account_campaign_mappings:all`, `all:read`, `all:all` - [Create api key](https://developer.instantly.ai/api-reference/apikey/create-api-key.md): Requires one of the following scopes: `api_keys:create`, `api_keys:all`, `all:create`, `all:all` - [Delete api key](https://developer.instantly.ai/api-reference/apikey/delete-api-key.md): Requires one of the following scopes: `api_keys:delete`, `api_keys:all`, `all:delete`, `all:all` - [List api key](https://developer.instantly.ai/api-reference/apikey/list-api-key.md): Requires one of the following scopes: `api_keys:read`, `api_keys:all`, `all:read`, `all:all` - [List audit log](https://developer.instantly.ai/api-reference/auditlog/list-audit-log.md): Requires one of the following scopes: `audit_logs:read`, `audit_logs:all`, `all:read`, `all:all` - [Get background job](https://developer.instantly.ai/api-reference/backgroundjob/get-background-job.md): Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all` - [List background job](https://developer.instantly.ai/api-reference/backgroundjob/list-background-job.md): Requires one of the following scopes: `background-jobs:read`, `background-jobs:all`, `all:read`, `all:all` - [Bulk create block list entry](https://developer.instantly.ai/api-reference/blocklistentry/bulk-create-block-list-entry.md): Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all` - [Bulk delete block list entry](https://developer.instantly.ai/api-reference/blocklistentry/bulk-delete-block-list-entry.md): Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all` - [Create block list entry](https://developer.instantly.ai/api-reference/blocklistentry/create-block-list-entry.md): Requires one of the following scopes: `block_list_entries:create`, `block_list_entries:all`, `all:create`, `all:all` - [Delete all block list entries](https://developer.instantly.ai/api-reference/blocklistentry/delete-all-block-list-entries.md): Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all` - [Delete block list entry](https://developer.instantly.ai/api-reference/blocklistentry/delete-block-list-entry.md): Requires one of the following scopes: `block_list_entries:delete`, `block_list_entries:all`, `all:delete`, `all:all` - [Download all block list entries as CSV](https://developer.instantly.ai/api-reference/blocklistentry/download-all-block-list-entries-as-csv.md): Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all` - [Get block list entry](https://developer.instantly.ai/api-reference/blocklistentry/get-block-list-entry.md): Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all` - [List block list entry](https://developer.instantly.ai/api-reference/blocklistentry/list-block-list-entry.md): Requires one of the following scopes: `block_list_entries:read`, `block_list_entries:all`, `all:read`, `all:all` - [Patch block list entry](https://developer.instantly.ai/api-reference/blocklistentry/patch-block-list-entry.md): Requires one of the following scopes: `block_list_entries:update`, `block_list_entries:all`, `all:update`, `all:all` - [Activate(start), or resume a campaign](https://developer.instantly.ai/api-reference/campaign/activatestart-or-resume-a-campaign.md): Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all` - [Add campaign variables](https://developer.instantly.ai/api-reference/campaign/add-campaign-variables.md): Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all` - [Create campaign](https://developer.instantly.ai/api-reference/campaign/create-campaign.md): Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all` - [Create campaign from shared one](https://developer.instantly.ai/api-reference/campaign/create-campaign-from-shared-one.md): Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all` - [Delete campaign](https://developer.instantly.ai/api-reference/campaign/delete-campaign.md): Requires one of the following scopes: `campaigns:delete`, `campaigns:all`, `all:delete`, `all:all` - [Duplicate campaign](https://developer.instantly.ai/api-reference/campaign/duplicate-campaign.md): Requires one of the following scopes: `campaigns:create`, `campaigns:all`, `all:create`, `all:all` - [Export campaign to JSON format](https://developer.instantly.ai/api-reference/campaign/export-campaign-to-json-format.md): Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` - [Get campaign](https://developer.instantly.ai/api-reference/campaign/get-campaign.md): Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` - [Get campaign sending status](https://developer.instantly.ai/api-reference/campaign/get-campaign-sending-status.md): 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. - [Get campaign steps analytics](https://developer.instantly.ai/api-reference/campaign/get-campaign-steps-analytics.md): Get campaign steps analytics - [Get campaign(s) analytics](https://developer.instantly.ai/api-reference/campaign/get-campaigns-analytics.md): 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 - [Get campaign(s) analytics overview](https://developer.instantly.ai/api-reference/campaign/get-campaigns-analytics-overview.md): 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. - [Get daily campaign analytics](https://developer.instantly.ai/api-reference/campaign/get-daily-campaign-analytics.md): Get campaign daily analytics - [Get launched campaigns count](https://developer.instantly.ai/api-reference/campaign/get-launched-campaigns-count.md): Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` - [List campaign](https://developer.instantly.ai/api-reference/campaign/list-campaign.md): Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` - [Patch campaign](https://developer.instantly.ai/api-reference/campaign/patch-campaign.md): Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all` - [Search campaigns by lead email](https://developer.instantly.ai/api-reference/campaign/search-campaigns-by-lead-email.md): Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all` - [Share a campaign](https://developer.instantly.ai/api-reference/campaign/share-a-campaign.md): 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 - [Stop(or pause) a campaign](https://developer.instantly.ai/api-reference/campaign/stopor-pause-a-campaign.md): Requires one of the following scopes: `campaigns:update`, `campaigns:all`, `all:update`, `all:all` - [Create campaign subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/create-campaign-subsequence.md): Requires one of the following scopes: `subsequences:create`, `subsequences:all`, `all:create`, `all:all` - [Delete campaign subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/delete-campaign-subsequence.md): Requires one of the following scopes: `subsequences:delete`, `subsequences:all`, `all:delete`, `all:all` - [Duplicate a subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/duplicate-a-subsequence.md): Duplicate a subsequence with the same trigger conditions - [Get campaign subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/get-campaign-subsequence.md): Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all` - [Get subsequence sending status](https://developer.instantly.ai/api-reference/campaignsubsequence/get-subsequence-sending-status.md): 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. - [List campaign subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/list-campaign-subsequence.md): Requires one of the following scopes: `subsequences:read`, `subsequences:all`, `all:read`, `all:all` - [Patch campaign subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/patch-campaign-subsequence.md): Requires one of the following scopes: `subsequences:update`, `subsequences:all`, `all:update`, `all:all` - [Pause a subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/pause-a-subsequence.md): Pause a subsequence - [Resume a paused subsequence](https://developer.instantly.ai/api-reference/campaignsubsequence/resume-a-paused-subsequence.md): Resume a paused subsequence - [Delete phone number](https://developer.instantly.ai/api-reference/crmactions/delete-phone-number.md): Delete a specific phone number from the organization. - [List phone numbers](https://developer.instantly.ai/api-reference/crmactions/list-phone-numbers.md): Retrieve all phone numbers associated with the current organization. - [Assign or unassign tags to resources](https://developer.instantly.ai/api-reference/customtag/assign-or-unassign-tags-to-resources.md): This can be used for both accounts and campaigns. Please check the `resource_type` field for more information. - [Create custom tag](https://developer.instantly.ai/api-reference/customtag/create-custom-tag.md): Requires one of the following scopes: `custom_tags:create`, `custom_tags:all`, `all:create`, `all:all` - [Delete custom tag](https://developer.instantly.ai/api-reference/customtag/delete-custom-tag.md): Requires one of the following scopes: `custom_tags:delete`, `custom_tags:all`, `all:delete`, `all:all` - [Get custom tag](https://developer.instantly.ai/api-reference/customtag/get-custom-tag.md): Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all` - [List custom tag](https://developer.instantly.ai/api-reference/customtag/list-custom-tag.md): Requires one of the following scopes: `custom_tags:read`, `custom_tags:all`, `all:read`, `all:all` - [Patch custom tag](https://developer.instantly.ai/api-reference/customtag/patch-custom-tag.md): Requires one of the following scopes: `custom_tags:update`, `custom_tags:all`, `all:update`, `all:all` - [List custom tag mapping](https://developer.instantly.ai/api-reference/customtagmapping/list-custom-tag-mapping.md): Requires one of the following scopes: `custom_tag_mappings:read`, `custom_tag_mappings:all`, `all:read`, `all:all` - [Cancel dfy email accounts](https://developer.instantly.ai/api-reference/dfyemailaccountorder/cancel-dfy-email-accounts.md): This endpoint will cancel the DFY email accounts based on the provided email addresses. - [Check domains availability](https://developer.instantly.ai/api-reference/dfyemailaccountorder/check-domains-availability.md): This endpoint will check the availability of the provided domains.. It will return a list of domains with their availability status. - [Generate similar available domains](https://developer.instantly.ai/api-reference/dfyemailaccountorder/generate-similar-available-domains.md): 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. - [Get pre-warmed up domains](https://developer.instantly.ai/api-reference/dfyemailaccountorder/get-pre-warmed-up-domains.md): This endpoint will return a list of pre-warmed up domains available for order.
These domains are set up and configured in advance, allowing for quick deployment of email services.
Use this endpoint to retrieve available pre-warmed up domains before placing an order.

IMPORTANT: if… - [List dfy email account order](https://developer.instantly.ai/api-reference/dfyemailaccountorder/list-dfy-email-account-order.md): Requires one of the following scopes: `dfy_email_account_orders:read`, `dfy_email_account_orders:all`, `all:read`, `all:all` - [List DFY ordered email accounts](https://developer.instantly.ai/api-reference/dfyemailaccountorder/list-dfy-ordered-email-accounts.md): This endpoint will return a list of DFY email accounts ordered - [Place a DFY email account order](https://developer.instantly.ai/api-reference/dfyemailaccountorder/place-a-dfy-email-account-order.md): This endpoint allows you to place an order for Done-For-You (DFY) email accounts with your own custom domains.
You can order up to 5 email accounts per domain for Google, or up to 50 for Microsoft/Outlook (requires the fe-dfy-microsoft feature flag).
This endpoint can place a DFY order, a pr… - [Count unread emails](https://developer.instantly.ai/api-reference/email/count-unread-emails.md): Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all` - [Delete email](https://developer.instantly.ai/api-reference/email/delete-email.md): Requires one of the following scopes: `emails:delete`, `emails:all`, `all:delete`, `all:all` - [Forward an email](https://developer.instantly.ai/api-reference/email/forward-an-email.md): 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. - [Get email](https://developer.instantly.ai/api-reference/email/get-email.md): Requires one of the following scopes: `emails:read`, `emails:all`, `all:read`, `all:all` - [List email](https://developer.instantly.ai/api-reference/email/list-email.md): **Rate Limit:** This endpoint has a rate limit of 20 requests per minute, unlike other API endpoints. - [Mark all emails in a thread as read](https://developer.instantly.ai/api-reference/email/mark-all-emails-in-a-thread-as-read.md): Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all` - [Patch email](https://developer.instantly.ai/api-reference/email/patch-email.md): Requires one of the following scopes: `emails:update`, `emails:all`, `all:update`, `all:all` - [Reply to an email](https://developer.instantly.ai/api-reference/email/reply-to-an-email.md): 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 existi… - [Send a test email](https://developer.instantly.ai/api-reference/email/send-a-test-email.md): Send a preview/test email without creating an email entity in Unibox. Rate limit: 10 requests per minute per workspace. - [Check an email verification status](https://developer.instantly.ai/api-reference/emailverification/check-an-email-verification-status.md): Requires one of the following scopes: `email_verifications:read`, `email_verifications:all`, `all:read`, `all:all` - [Create email verification](https://developer.instantly.ai/api-reference/emailverification/create-email-verification.md): 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. - [Account](https://developer.instantly.ai/api-reference/groups/account.md): An email account that can be used to send campaigns - [Account Campaign Mapping](https://developer.instantly.ai/api-reference/groups/account-campaign-mapping.md): Account Campaign Mapping - [Analytics](https://developer.instantly.ai/api-reference/groups/analytics.md): Endpoints related to analytics - [API Key](https://developer.instantly.ai/api-reference/groups/api-key.md): API Key - [Audit Log](https://developer.instantly.ai/api-reference/groups/audit-log.md): Audit log records for tracking system activities - [Background Job](https://developer.instantly.ai/api-reference/groups/background-job.md): A background job that can be used to perform long-running tasks - [Block List Entry](https://developer.instantly.ai/api-reference/groups/block-list-entry.md): A blocked email or domain - [Campaign](https://developer.instantly.ai/api-reference/groups/campaign.md): A campaign that can be sent to a list of recipients - [Campaign Subsequence](https://developer.instantly.ai/api-reference/groups/campaign-subsequence.md): A subsequence entity representing a follow-up sequence - [CRM Actions](https://developer.instantly.ai/api-reference/groups/crm-actions.md): CRM related actions - [Custom Tag](https://developer.instantly.ai/api-reference/groups/custom-tag.md): A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. - [Custom Tag Mapping](https://developer.instantly.ai/api-reference/groups/custom-tag-mapping.md): This entity represents a tag being assigned to a specific campaign or email account. - [DFY Email Account Order](https://developer.instantly.ai/api-reference/groups/dfy-email-account-order.md): A Done-For-You email account order - [Email](https://developer.instantly.ai/api-reference/groups/email.md): A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox - [Email Verification](https://developer.instantly.ai/api-reference/groups/email-verification.md): A single email verification - [Inbox Placement Analytics](https://developer.instantly.ai/api-reference/groups/inbox-placement-analytics.md): Analytics data for individual emails in inbox placement tests - [Inbox Placement Blacklist & SpamAssassin Report](https://developer.instantly.ai/api-reference/groups/inbox-placement-reports.md): Report data for an inbox placement test - [Inbox Placement Test](https://developer.instantly.ai/api-reference/groups/inbox-placement-test.md): An inbox placement test - [Lead](https://developer.instantly.ai/api-reference/groups/lead.md): A lead entity representing an individual lead - [Lead Label](https://developer.instantly.ai/api-reference/groups/lead-label.md): A custom label for categorizing and managing leads - [Lead List](https://developer.instantly.ai/api-reference/groups/lead-list.md): A list used to store leads - [OAuth](https://developer.instantly.ai/api-reference/groups/oauth.md): OAuth authentication endpoints for connecting Google and Microsoft email accounts - [SuperSearch Enrichment](https://developer.instantly.ai/api-reference/groups/supersearch-enrichment.md): An enrichment can take different forms, including standard data enrichment and AI-powered enrichment. - [Webhook](https://developer.instantly.ai/api-reference/groups/webhook.md): A webhook subscription for receiving event notifications - [Webhook Event](https://developer.instantly.ai/api-reference/groups/webhook-event.md): A webhook event that was sent or attempted to be sent - [Workspace](https://developer.instantly.ai/api-reference/groups/workspace.md): A workspace entity representing a workspace - [Workspace Billing](https://developer.instantly.ai/api-reference/groups/workspace-billing.md): Workspace Billing - [Workspace Group Member](https://developer.instantly.ai/api-reference/groups/workspace-group-member.md): A member of a workspace group. - [Workspace Member](https://developer.instantly.ai/api-reference/groups/workspace-member.md): A member of a workspace with associated user details - [Get inbox placement analytics](https://developer.instantly.ai/api-reference/inboxplacementanalytics/get-inbox-placement-analytics.md): Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all` - [Get inbox placement analytics stats by date](https://developer.instantly.ai/api-reference/inboxplacementanalytics/get-inbox-placement-analytics-stats-by-date.md): Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests. - [List inbox placement analytics](https://developer.instantly.ai/api-reference/inboxplacementanalytics/list-inbox-placement-analytics.md): Requires one of the following scopes: `inbox_placement_analytics:read`, `inbox_placement_analytics:all`, `all:read`, `all:all` - [Retrieve inbox placement analytics deliverability insights](https://developer.instantly.ai/api-reference/inboxplacementanalytics/retrieve-inbox-placement-analytics-deliverability-insights.md): Provides deliverability insights for a specific inbox placement test - [Retrieve inbox placement analytics stats by test id](https://developer.instantly.ai/api-reference/inboxplacementanalytics/retrieve-inbox-placement-analytics-stats-by-test-id.md): Provides aggregated inbox, spam and category counts for specified test IDs - [Get inbox placement blacklist & spamassassin report](https://developer.instantly.ai/api-reference/inboxplacementblacklist&spamassassinreport/get-inbox-placement-blacklist-&-spamassassin-report.md): Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all` - [List inbox placement blacklist & spamassassin report](https://developer.instantly.ai/api-reference/inboxplacementblacklist&spamassassinreport/list-inbox-placement-blacklist-&-spamassassin-report.md): Requires one of the following scopes: `inbox_placement_reports:read`, `inbox_placement_reports:all`, `all:read`, `all:all` - [Create inbox placement test](https://developer.instantly.ai/api-reference/inboxplacementtest/create-inbox-placement-test.md): Requires one of the following scopes: `inbox_placement_tests:create`, `inbox_placement_tests:all`, `all:create`, `all:all` - [Delete inbox placement test](https://developer.instantly.ai/api-reference/inboxplacementtest/delete-inbox-placement-test.md): Requires one of the following scopes: `inbox_placement_tests:delete`, `inbox_placement_tests:all`, `all:delete`, `all:all` - [Get ESP options](https://developer.instantly.ai/api-reference/inboxplacementtest/get-esp-options.md): Provides a list of available email service providers for inbox placement tests. - [Get inbox placement test](https://developer.instantly.ai/api-reference/inboxplacementtest/get-inbox-placement-test.md): Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all` - [List inbox placement test](https://developer.instantly.ai/api-reference/inboxplacementtest/list-inbox-placement-test.md): Requires one of the following scopes: `inbox_placement_tests:read`, `inbox_placement_tests:all`, `all:read`, `all:all` - [Patch inbox placement test](https://developer.instantly.ai/api-reference/inboxplacementtest/patch-inbox-placement-test.md): Requires one of the following scopes: `inbox_placement_tests:update`, `inbox_placement_tests:all`, `all:update`, `all:all` - [Introduction](https://developer.instantly.ai/api-reference/introduction.md): This documentation is for the second version of the Instantly API. - [Add leads in bulk to a campaign or list](https://developer.instantly.ai/api-reference/lead/add-leads-in-bulk-to-a-campaign-or-list.md): 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. - [Bulk assign leads to organization users](https://developer.instantly.ai/api-reference/lead/bulk-assign-leads-to-organization-users.md): Bulk assign leads to organization users - [Create lead](https://developer.instantly.ai/api-reference/lead/create-lead.md): Requires one of the following scopes: `leads:create`, `leads:all`, `all:create`, `all:all` - [Delete lead](https://developer.instantly.ai/api-reference/lead/delete-lead.md): Requires one of the following scopes: `leads:delete`, `leads:all`, `all:delete`, `all:all` - [Delete leads in bulk](https://developer.instantly.ai/api-reference/lead/delete-leads-in-bulk.md): 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. - [Get lead](https://developer.instantly.ai/api-reference/lead/get-lead.md): Requires one of the following scopes: `leads:read`, `leads:all`, `all:read`, `all:all` - [List leads](https://developer.instantly.ai/api-reference/lead/list-leads.md): 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… - [Merge two leads](https://developer.instantly.ai/api-reference/lead/merge-two-leads.md): Merge two leads - [Move a lead to a subsequence](https://developer.instantly.ai/api-reference/lead/move-a-lead-to-a-subsequence.md): Move a lead to a subsequence - [Move leads to a campaign or list](https://developer.instantly.ai/api-reference/lead/move-leads-to-a-campaign-or-list.md): 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. Not… - [Patch lead](https://developer.instantly.ai/api-reference/lead/patch-lead.md): Requires one of the following scopes: `leads:update`, `leads:all`, `all:update`, `all:all` - [Remove a lead from a subsequence](https://developer.instantly.ai/api-reference/lead/remove-a-lead-from-a-subsequence.md): Remove a lead from a subsequence - [Update the interest status of a lead](https://developer.instantly.ai/api-reference/lead/update-the-interest-status-of-a-lead.md): Update the interest status of a lead - [Create lead label](https://developer.instantly.ai/api-reference/leadlabel/create-lead-label.md): Requires one of the following scopes: `lead-labels:create`, `lead-labels:all`, `all:create`, `all:all` - [Delete lead label](https://developer.instantly.ai/api-reference/leadlabel/delete-lead-label.md): Requires one of the following scopes: `lead-labels:delete`, `lead-labels:all`, `all:delete`, `all:all` - [Get lead label](https://developer.instantly.ai/api-reference/leadlabel/get-lead-label.md): Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all` - [List lead label](https://developer.instantly.ai/api-reference/leadlabel/list-lead-label.md): Requires one of the following scopes: `lead-labels:read`, `lead-labels:all`, `all:read`, `all:all` - [Patch lead label](https://developer.instantly.ai/api-reference/leadlabel/patch-lead-label.md): Requires one of the following scopes: `lead-labels:update`, `lead-labels:all`, `all:update`, `all:all` - [Test AI reply label prediction](https://developer.instantly.ai/api-reference/leadlabel/test-ai-reply-label-prediction.md): 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… - [Create lead list](https://developer.instantly.ai/api-reference/leadlist/create-lead-list.md): Requires one of the following scopes: `lead_lists:create`, `lead_lists:all`, `all:create`, `all:all` - [Delete lead list](https://developer.instantly.ai/api-reference/leadlist/delete-lead-list.md): Requires one of the following scopes: `lead_lists:delete`, `lead_lists:all`, `all:delete`, `all:all` - [Get lead list](https://developer.instantly.ai/api-reference/leadlist/get-lead-list.md): Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all` - [Get verification statistics for a lead list](https://developer.instantly.ai/api-reference/leadlist/get-verification-statistics-for-a-lead-list.md): Get verification statistics for a lead list - [List lead list](https://developer.instantly.ai/api-reference/leadlist/list-lead-list.md): Requires one of the following scopes: `lead_lists:read`, `lead_lists:all`, `all:read`, `all:all` - [Patch lead list](https://developer.instantly.ai/api-reference/leadlist/patch-lead-list.md): Requires one of the following scopes: `lead_lists:update`, `lead_lists:all`, `all:update`, `all:all` - [Get oauth session status](https://developer.instantly.ai/api-reference/oauth/get-oauth-session-status.md): 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. - [Initialize google oauth](https://developer.instantly.ai/api-reference/oauth/initialize-google-oauth.md): 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. - [Initialize microsoft oauth](https://developer.instantly.ai/api-reference/oauth/initialize-microsoft-oauth.md): 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. - [Schemas](https://developer.instantly.ai/api-reference/schemas/index.md): Browse all API data models and their field definitions. - [Count leads from supersearch](https://developer.instantly.ai/api-reference/supersearchenrichment/count-leads-from-supersearch.md): Count the number of leads matching a SuperSearch query without enriching them. This endpoint is intended to estimate lead availability before running an enrichment. - [Create AI enrichment](https://developer.instantly.ai/api-reference/supersearchenrichment/create-ai-enrichment.md): Create an AI enrichment for a resource (list or campaign) - [Create an enrichment](https://developer.instantly.ai/api-reference/supersearchenrichment/create-an-enrichment.md): 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. - [Enrich leads from supersearch](https://developer.instantly.ai/api-reference/supersearchenrichment/enrich-leads-from-supersearch.md): Add leads from SuperSearch to a list and enrich them. A list is automatically created if no list is provided. - [Get AI enrichment for resource](https://developer.instantly.ai/api-reference/supersearchenrichment/get-ai-enrichment-for-resource.md): Get the AI enrichment for a specific resource - [Get enrichment for resource](https://developer.instantly.ai/api-reference/supersearchenrichment/get-enrichment-for-resource.md): Get the enrichment for a specific resource - [Get enrichment history](https://developer.instantly.ai/api-reference/supersearchenrichment/get-enrichment-history.md): Retrieve the enrichment history for a specific resource - [Preview leads from supersearch](https://developer.instantly.ai/api-reference/supersearchenrichment/preview-leads-from-supersearch.md): Preview the leads matching a SuperSearch query without enriching them - [Run enrichment for resource](https://developer.instantly.ai/api-reference/supersearchenrichment/run-enrichment-for-resource.md): Run all enrichments associated with a resource for a list of leads or for all the leads that haven't been enriched yet - [Update enrichment settings for resource](https://developer.instantly.ai/api-reference/supersearchenrichment/update-enrichment-settings-for-resource.md): Update auto-update and skip settings for a SuperSearch enrichment tied to a specific resource - [Create webhook](https://developer.instantly.ai/api-reference/webhook/create-webhook.md): Requires one of the following scopes: `webhooks:create`, `webhooks:all`, `all:create`, `all:all` - [Delete webhook](https://developer.instantly.ai/api-reference/webhook/delete-webhook.md): Requires one of the following scopes: `webhooks:delete`, `webhooks:all`, `all:delete`, `all:all` - [Get webhook](https://developer.instantly.ai/api-reference/webhook/get-webhook.md): Requires one of the following scopes: `webhooks:read`, `webhooks:all`, `all:read`, `all:all` - [List available event types](https://developer.instantly.ai/api-reference/webhook/list-available-event-types.md): Get all available webhook event types including custom labels - [List webhooks](https://developer.instantly.ai/api-reference/webhook/list-webhooks.md): List all webhooks for the workspace with optional filters - [Patch webhook](https://developer.instantly.ai/api-reference/webhook/patch-webhook.md): Requires one of the following scopes: `webhooks:update`, `webhooks:all`, `all:update`, `all:all` - [Resume a webhook](https://developer.instantly.ai/api-reference/webhook/resume-a-webhook.md): Resume a webhook that was disabled due to repeated delivery failures - [Test a webhook](https://developer.instantly.ai/api-reference/webhook/test-a-webhook.md): Send a test payload to a webhook URL to verify it is working - [Get overview aggregates for webhook events](https://developer.instantly.ai/api-reference/webhookevent/get-overview-aggregates-for-webhook-events.md): Get overview aggregates for webhook events including success/failure rates - [Get overview aggregates for webhook events by date](https://developer.instantly.ai/api-reference/webhookevent/get-overview-aggregates-for-webhook-events-by-date.md): Get overview aggregates for webhook events by Date for charts - [Get webhook event](https://developer.instantly.ai/api-reference/webhookevent/get-webhook-event.md): Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all` - [List webhook event](https://developer.instantly.ai/api-reference/webhookevent/list-webhook-event.md): Requires one of the following scopes: `webhook_events:read`, `webhook_events:all`, `all:read`, `all:all` - [Change workspace owner](https://developer.instantly.ai/api-reference/workspace/change-workspace-owner.md): Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all` - [Delete organization agency domain](https://developer.instantly.ai/api-reference/workspace/delete-organization-agency-domain.md): Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all` - [Get organization verified agency domain information](https://developer.instantly.ai/api-reference/workspace/get-organization-verified-agency-domain-information.md): Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all` - [Get workspace](https://developer.instantly.ai/api-reference/workspace/get-workspace.md): 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. - [Patch workspace](https://developer.instantly.ai/api-reference/workspace/patch-workspace.md): 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. - [Set the agency domain for the workspace](https://developer.instantly.ai/api-reference/workspace/set-the-agency-domain-for-the-workspace.md): Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all` - [Get workspace plan details](https://developer.instantly.ai/api-reference/workspacebilling/get-workspace-plan-details.md): Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all` - [Get workspace subscription details](https://developer.instantly.ai/api-reference/workspacebilling/get-workspace-subscription-details.md): Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all` - [Create workspace group member](https://developer.instantly.ai/api-reference/workspacegroupmember/create-workspace-group-member.md): 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. - [Delete workspace group member](https://developer.instantly.ai/api-reference/workspacegroupmember/delete-workspace-group-member.md): Requires one of the following scopes: `workspace_group_members:delete`, `workspace_group_members:all`, `all:delete`, `all:all` - [Get the current workspace admin workspace](https://developer.instantly.ai/api-reference/workspacegroupmember/get-the-current-workspace-admin-workspace.md): Get the details of the admin workspace of the current workspace - [Get workspace group member](https://developer.instantly.ai/api-reference/workspacegroupmember/get-workspace-group-member.md): Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all` - [List workspace group member](https://developer.instantly.ai/api-reference/workspacegroupmember/list-workspace-group-member.md): Requires one of the following scopes: `workspace_group_members:read`, `workspace_group_members:all`, `all:read`, `all:all` - [Create workspace member](https://developer.instantly.ai/api-reference/workspacemember/create-workspace-member.md): Requires one of the following scopes: `workspace_members:create`, `workspace_members:all`, `all:create`, `all:all` - [Delete workspace member](https://developer.instantly.ai/api-reference/workspacemember/delete-workspace-member.md): Requires one of the following scopes: `workspace_members:delete`, `workspace_members:all`, `all:delete`, `all:all` - [Get workspace member](https://developer.instantly.ai/api-reference/workspacemember/get-workspace-member.md): Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all` - [List workspace member](https://developer.instantly.ai/api-reference/workspacemember/list-workspace-member.md): Requires one of the following scopes: `workspace_members:read`, `workspace_members:all`, `all:read`, `all:all` - [Patch workspace member](https://developer.instantly.ai/api-reference/workspacemember/patch-workspace-member.md): Requires one of the following scopes: `workspace_members:update`, `workspace_members:all`, `all:update`, `all:all` - [Authorization](https://developer.instantly.ai/getting-started/authorization.md): Instantly API Authorization Guide - [Getting Started](https://developer.instantly.ai/getting-started/getting-started.md): Please read the guide below to get started with the second version of our API. - [Rate Limit](https://developer.instantly.ai/getting-started/rate-limit.md): Learn about the API rate limits and how to handle them. - [Slack channel](https://developer.instantly.ai/getting-started/slack-channel.md): Join the Instantly developer Slack community to discuss APIs, ask questions, and share feedback. - [API v1 to v2 migration](https://developer.instantly.ai/guides/api-v1-migration.md): Endpoint mapping and migration guide for moving from API v1 to API v2. - [OAuth connection flow](https://developer.instantly.ai/guides/oauth-connection-flow.md): Programmatically connect Google and Microsoft OAuth accounts to your Instantly workspace. - [Webhook events](https://developer.instantly.ai/guides/webhook-events.md): Schema reference and event types for Instantly webhook payloads. - [Workspace group](https://developer.instantly.ai/guides/workspace-group.md): Manage multiple sub workspaces from a single admin workspace using the workspace group feature. ## OpenAPI Specs - [api_v2](https://api.instantly.ai/openapi/api_v2.json)