Skip to content
Changelog

Report a bug

Instantly integration: operations for AI agents

Instantly connects to Type.com as an integration. This page lists the 255 operations documented for Claude and Codex in Type.com: 118 read, 105 write, 32 destructive.

About Instantly

Instantly is a platform designed to streamline cold email outreach by automating campaigns, managing leads, and enhancing email deliverability.

Categories: Email & Messaging

How to connect Instantly to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

255 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

255 operations listed.

Account Campaign Mapping

  • Read

    Get campaigns associated with an email

    Requires one of the following scopes: accountcampaignmappings:read, accountcampaignmappings:all, all:read, all:all

Account

  • Read

    List account

    Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

  • Read

    Get account

    Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

  • Read

    Get warmup analytics

    Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

  • Read

    Get daily account analytics

    Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts.

  • Read

    Get custom tracking domain status

    Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

  • Write

    Create account

    Requires one of the following scopes: accounts:create, accounts:all, all:create, all:all

  • Write

    Patch account

    Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

  • Write

    Enable warmup for accounts

    Initiates a background job to enable warmup for the specified accounts. The response will contain the initial background job object. You can monitor the job's progress by polling the GET: /api/v2/background-jobs/:id endpoint.

  • Write

    Disable warmup for accounts

    Initiates a background job to disable warmup for the specified accounts. The response will contain the initial background job object. You can monitor the job's progress by polling the GET: /api/v2/background-jobs/:id endpoint.

  • Write

    Pause multiple accounts

    Pauses up to 100 email accounts in the authenticated workspace. Each unique email is returned in either pausedemails or failedemails. Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

  • Write

    Pause an account

    Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

  • Write

    Resume a paused account

    Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

  • Write

    Mark an account as fixed

    Sets the account to active and clears leftover error metadata such as statusmessage. Idempotent when the account is already active. Requires one of the following scopes: accounts:update, accounts:all, all:update, all:all

  • Write

    Test account vitals

    Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

  • Write

    Move accounts between workspaces

    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.

  • Destructive

    Delete account

    Requires one of the following scopes: accounts:delete, accounts:all, all:delete, all:all

Engage Item

  • Read

    List AI agent items

    Requires one of the following scopes: all:read, all:all

  • Write

    Bulk delete AI agent items

    Requires one of the following scopes: all:delete, all:all

APIKey

  • Read

    List api key

    Requires one of the following scopes: apikeys:read, apikeys:all, all:read, all:all

  • Write

    Create api key

    Requires one of the following scopes: apikeys:create, apikeys:all, all:create, all:all

  • Destructive

    Delete api key

    Requires one of the following scopes: apikeys:delete, apikeys:all, all:delete, all:all

Audit Log

  • Read

    List audit log

    Requires one of the following scopes: auditlogs:read, auditlogs:all, all:read, all:all

Background Job

  • Read

    List background job

    Requires one of the following scopes: background-jobs:read, background-jobs:all, all:read, all:all

  • Read

    Get background job

    Requires one of the following scopes: background-jobs:read, background-jobs:all, all:read, all:all

Block List Entry

  • Read

    List block list entry

    Requires one of the following scopes: blocklistentries:read, blocklistentries:all, all:read, all:all

  • Read

    Get block list entry

    Requires one of the following scopes: blocklistentries:read, blocklistentries:all, all:read, all:all

  • Read

    Download all block list entries as CSV

    Requires one of the following scopes: blocklistentries:read, blocklistentries:all, all:read, all:all

  • Write

    Create block list entry

    Requires one of the following scopes: blocklistentries:create, blocklistentries:all, all:create, all:all

  • Write

    Patch block list entry

    Requires one of the following scopes: blocklistentries:update, blocklistentries:all, all:update, all:all

  • Write

    Bulk create block list entry

    Requires one of the following scopes: blocklistentries:create, blocklistentries:all, all:create, all:all

  • Write

    Bulk delete block list entry

    Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all

  • Destructive

    Delete all block list entries

    Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all

  • Destructive

    Delete block list entry

    Requires one of the following scopes: blocklistentries:delete, blocklistentries:all, all:delete, all:all

Campaign

  • Read

    List campaign

    Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all

  • Read

    Get campaign

    Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all

  • Read

    Search campaigns by lead email

    Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all

  • Read

    Get campaign(s) analytics

    Get analytics for one or multiple campaigns. Specify the id field to get the analytics for a single campaign, or leave it empty to get the analytics for all campaigns

  • Read

    Get campaign(s) analytics overview

    Get analytics overview for one or multiple campaigns. Specify the id field to get the analytics overview for a single campaign, or leave it empty to get the analytics overview for all campaigns.

  • Read

    Get daily campaign analytics

    Get campaign daily analytics

  • Read

    Get campaign steps analytics

    Get campaign steps analytics

  • Read

    Export campaign to JSON format

    Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all

  • Read

    Get launched campaigns count

    Requires one of the following scopes: campaigns:read, campaigns:all, all:read, all:all

  • Read

    Get campaign sending status

    Returns sending status data explaining why a campaign may not be sending emails or is sending slower than expected. Note: Some fields may be missing when the campaign is out of schedule. Always-present fields: campaignid, lastupdated, status, issuetracking.

  • Write

    Create campaign

    Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all

  • Write

    Activate(start), or resume a campaign

    Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all

  • Write

    Stop(or pause) a campaign

    Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all

  • Write

    Patch campaign

    Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all

  • Write

    Share a campaign

    Share a campaign. This allows other users to create new campaigns based on this campaign. The campaign is being shared for 7 days, after which you'll have to call this endpoint again if you want to enable sharing on the campaign

  • Write

    Create campaign from shared one

    Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all

  • Write

    Duplicate campaign

    Requires one of the following scopes: campaigns:create, campaigns:all, all:create, all:all

  • Write

    Add campaign variables

    Requires one of the following scopes: campaigns:update, campaigns:all, all:update, all:all

  • Destructive

    Delete campaign

    Requires one of the following scopes: campaigns:delete, campaigns:all, all:delete, all:all

CRMActions

  • Read

    List phone numbers

    Retrieve all phone numbers associated with the current organization. Requires one of the following scopes: crmactions:read, crmactions:all, all:read, all:all

  • Destructive

    Delete phone number

    Remove a phone number from the organization. Provider cleanup is retried automatically if delayed. Deleting an unknown or already removed number returns 404. A number that cannot be released because the workspace has no phone account returns 409 and is kept.

Custom Tag Mapping

  • Read

    List custom tag mapping

    Requires one of the following scopes: customtagmappings:read, customtagmappings:all, all:read, all:all

Custom Tag

  • Read

    List custom tag

    Requires one of the following scopes: customtags:read, customtags:all, all:read, all:all

  • Read

    Get custom tag

    Requires one of the following scopes: customtags:read, customtags:all, all:read, all:all

  • Write

    Create custom tag

    Requires one of the following scopes: customtags:create, customtags:all, all:create, all:all

  • Write

    Patch custom tag

    Requires one of the following scopes: customtags:update, customtags:all, all:update, all:all

  • Write

    Assign or unassign tags to resources

    This can be used for both accounts and campaigns. Please check the resourcetype field for more information.

  • Destructive

    Delete custom tag

    Requires one of the following scopes: customtags:delete, customtags:all, all:delete, all:all

DFYEmail Account Order

  • Read

    List dfy email account order

    Requires one of the following scopes: dfyemailaccountorders:read, dfyemailaccountorders:all, all:read, all:all

  • Read

    Check domains availability

    This endpoint will check the availability of the provided domains.. It will return a list of domains with their availability status. . The only supported extensions (tlds) are: .com, .org. . Only registrable domains are supported: subdomains are rejected. .

  • Read

    Get pre-warmed up domains

    This endpoint will return a list of pre-warmed up domains available for order. These domains are set up and configured in advance, allowing for quick deployment of email services. Use this endpoint to retrieve available pre-warmed up domains before placing an order.

  • Read

    List DFY ordered email accounts

    This endpoint will return a list of DFY email accounts ordered Requires one of the following scopes: dfyemailaccountorders:read, dfyemailaccountorders:all, all:read, all:all

  • Write

    Place a DFY email account order

    Place a Done-For-You (DFY) email account order for your workspace. Order types - dfy: Buy new DFY accounts on new custom domains. - prewarmedup: Buy available pre-warmed domains returned by /dfy-email-account-orders/domains/pre-warmed-up-list.

  • Write

    Generate similar available domains

    This endpoint will generate a list of similar AND available domains based on the provided domain.. It will return a maximum number of 67 suggestions per extension (tld) requested.. All the returned domains will be available for order..

  • Destructive

    Cancel dfy email accounts

    This endpoint will cancel the DFY email accounts based on the provided email addresses. Cancelling permanently deletes all Unibox emails and conversations associated with the cancelled accounts. This cannot be undone.

Domain Forwarding

  • Read

    Get domain forwarding

    Returns the stored web forwarding configuration for a domain ordered through Instantly. All fields except domain are null when no forwarding is configured. Requires one of the following scopes: dfyemailaccountorders:read, dfyemailaccountorders:all, all:read, all:all

  • Destructive

    Set domain forwarding

    Sets web forwarding on a domain ordered through Instantly. The forwarding domain must be a valid domain different from the domain itself.

  • Destructive

    Remove domain forwarding

    Removes web forwarding from a domain ordered through Instantly. This operation is idempotent: removing forwarding from a domain that has none configured succeeds without changes. This request has a rate limit of 10 requests per minute, or 60 requests per hour.

Email

  • Read

    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

  • Read

    Get email

    Requires one of the following scopes: emails:read, emails:all, all:read, all:all

  • Read

    Count unread emails

    Requires one of the following scopes: emails:read, emails:all, all:read, all:all

  • Write

    Send a test email

    Send a preview/test email without creating an email entity in Unibox. Rate limit: 10 requests per minute per workspace. Requires one of the following scopes: emails:create, emails:all, all:create, all:all

  • Write

    Reply to an email

    Send a reply to an email. This endpoint can be used to send an email only as a reply to an existing email. In order to reply to an email, please specify the reyplytouuid field, and your email will be sent as a reply to that email.

  • Write

    Forward an email

    Forward an existing email to another recipient. You must specify the replytouuid field, which represents the id of an existing email returned by the /emails endpoints. By default only the provided body is sent. Set includeoriginalbody to true to append the original email context.

  • Write

    Patch email

    Requires one of the following scopes: emails:update, emails:all, all:update, all:all

  • Write

    Mark all emails in a thread as read

    Requires one of the following scopes: emails:update, emails:all, all:update, all:all

  • Destructive

    Delete email

    Requires one of the following scopes: emails:delete, emails:all, all:delete, all:all

Inbox Placement Analytics

  • Read

    List inbox placement analytics

    Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all

  • Read

    Get inbox placement analytics

    Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all

  • Read

    Retrieve inbox placement analytics stats by test id

    Provides aggregated inbox, spam and category counts for specified test IDs Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all

  • Read

    Retrieve inbox placement analytics deliverability insights

    Provides deliverability insights for a specific inbox placement test Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all

  • Read

    Get inbox placement analytics stats by date

    Provides a time series representing the distribution of emails sent to inbox, spam, or category folders for scheduled inbox placement tests. Requires one of the following scopes: inboxplacementanalytics:read, inboxplacementanalytics:all, all:read, all:all

Inbox Placement Blacklist And Spam Assassin Report

  • Read

    List inbox placement blacklist and spamassassin report

    Requires one of the following scopes: inboxplacementreports:read, inboxplacementreports:all, all:read, all:all

  • Read

    Get inbox placement blacklist and spamassassin report

    Requires one of the following scopes: inboxplacementreports:read, inboxplacementreports:all, all:read, all:all

Inbox Placement Test

  • Read

    List inbox placement test

    Requires one of the following scopes: inboxplacementtests:read, inboxplacementtests:all, all:read, all:all

  • Read

    Get inbox placement test

    Requires one of the following scopes: inboxplacementtests:read, inboxplacementtests:all, all:read, all:all

  • Read

    Get ESP options

    Provides a list of available email service providers for inbox placement tests.

  • Write

    Create inbox placement test

    Requires one of the following scopes: inboxplacementtests:create, inboxplacementtests:all, all:create, all:all

  • Write

    Patch inbox placement test

    Requires one of the following scopes: inboxplacementtests:update, inboxplacementtests:all, all:update, all:all

  • Destructive

    Delete inbox placement test

    Requires one of the following scopes: inboxplacementtests:delete, inboxplacementtests:all, all:delete, all:all

Lead Label

  • Read

    List lead label

    Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

  • Read

    Get lead label

    Requires one of the following scopes: lead-labels:read, lead-labels:all, all:read, all:all

  • Write

    Create lead label

    Requires one of the following scopes: lead-labels:create, lead-labels:all, all:create, all:all

  • Write

    Patch lead label

    Requires one of the following scopes: lead-labels:update, lead-labels:all, all:update, all:all

  • Write

    Test AI reply label prediction

    Returns the AI-predicted lead label for a reply text. This simulates how AI auto-tagging would label an incoming reply for testing custom labels and descriptions. Rate limit: 500 requests per 30 days per workspace.

  • Destructive

    Delete lead label

    Requires one of the following scopes: lead-labels:delete, lead-labels:all, all:delete, all:all

Lead List

  • Read

    List lead list

    Requires one of the following scopes: leadlists:read, leadlists:all, all:read, all:all

  • Read

    Get lead list

    Requires one of the following scopes: leadlists:read, leadlists:all, all:read, all:all

  • Read

    Get verification statistics for a lead list

    Get verification statistics for a lead list

  • Write

    Create lead list

    Requires one of the following scopes: leadlists:create, leadlists:all, all:create, all:all

  • Write

    Patch lead list

    Requires one of the following scopes: leadlists:update, leadlists:all, all:update, all:all

  • Destructive

    Delete lead list

    Requires one of the following scopes: leadlists:delete, leadlists:all, all:delete, all:all

Lead

  • Read

    List leads

    This endpoint is a POST endpoint, instead of GET - a deviation from the REST APIs standards we’re following because of the complex arguments it accepts, which would be too hard to express through query parameters.

  • Read

    Get lead

    Requires one of the following scopes: leads:read, leads:all, all:read, all:all

  • Write

    Create lead

    Requires one of the following scopes: leads:create, leads:all, all:create, all:all

  • Write

    Patch lead

    Requires one of the following scopes: leads:update, leads:all, all:update, all:all

  • Write

    Merge two leads

    Merge two leads Requires one of the following scopes: leads:update, leads:all, all:update, all:all

  • Write

    Update the interest status of a lead

    Update the interest status of a lead

  • Write

    Bulk assign leads to organization users

    Bulk assign leads to organization users

  • Write

    Move leads to a campaign or list

    Move leads to a different campaign or list. This endpoint will return a background job that will process the move. The job will be processed in the background and the leads will be moved to the destination campaign or list.

  • Write

    Move a lead to a subsequence

    Move a lead to a subsequence Requires one of the following scopes: leads:update, leads:all, all:update, all:all

  • Write

    Add leads in bulk to a campaign or list

    Adds up to 1000 leads to either a campaign or a list. You must provide a campaignid or a listid, 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

  • Destructive

    Delete leads in bulk

    Delete multiple leads from a campaign or list based on filters. You must provide either campaignid or listid. Optionally filter by status or specific IDs. Requires one of the following scopes: leads:delete, leads:all, all:delete, all:all

  • Destructive

    Delete lead

    Requires one of the following scopes: leads:delete, leads:all, all:delete, all:all

  • Destructive

    Remove a lead from a subsequence

    Remove a lead from a subsequence Requires one of the following scopes: leads:update, leads:all, all:update, all:all

OAuth

  • Read

    Get oauth session status

    Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if something went wrong. Sessions expire after 10 minutes.

  • Write

    Initialize google oauth

    Creates an OAuth session and returns the Google authorization URL. The user should be redirected to authurl to complete the OAuth flow. Poll the status endpoint to check for completion.

  • Write

    Initialize microsoft oauth

    Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to authurl to complete the OAuth flow. Poll the status endpoint to check for completion.

Super Search Enrichment

  • Read

    Get AI enrichment for resource

    Get the AI enrichment for a specific resource Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Get enrichment for resource

    Get the enrichment for a specific resource

  • Read

    Count leads from supersearch

    Count the number of leads matching a SuperSearch query without enriching them. This endpoint is intended to estimate lead availability before running an enrichment. Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Preview leads from supersearch

    Preview the leads matching a SuperSearch query without enriching them Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Get enrichment history

    Retrieve the enrichment history for a specific resource Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Returns the full integration provider registry

    Returns every data-provider integration with its available lookup actions, per-action credit cost, and whether the requesting workspace has connected its own provider account (isConnected).

  • Read

    List saved searches

    List the workspace's saved SuperSearch queries, newest first. Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Get a saved search

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Write

    Facet keywords for a signal category

    Return the top matching keyword tokens for a given signal category and keyword field, aggregated from the last 90 days of signal data. Powers the Signals filter autocomplete in the Lead Finder. Unknown (category, field) pairs return 400.

  • Write

    Create AI enrichment

    Create an AI enrichment for a resource (list or campaign) Requires one of the following scopes: supersearchenrichments:create, supersearchenrichments:all, all:create, all:all

  • Write

    Create an enrichment

    Create an enrichment for a specific resource (list or campaign). This is the main endpoint for adding enrichments to resources. The enrichments are automatically run after creation.

  • Write

    Update enrichment settings for resource

    Update auto-update and skip settings for a SuperSearch enrichment tied to a specific resource Requires one of the following scopes: supersearchenrichments:create, supersearchenrichments:all, all:create, all:all

  • Write

    Enrich leads from supersearch

    Add leads from SuperSearch to a list and enrich them. A list is automatically created if no list is provided.

  • Write

    Run enrichment for resource

    Run all enrichments associated with a resource for a list of leads or for all the leads that haven't been enriched yet

  • Write

    Run a single integration lookup action synchronously

    Executes one lookup action for a single record with literal inputs and returns the provider payload inline, under the action's output column. Requires one of the following scopes: supersearchenrichments:create, supersearchenrichments:all, all:create, all:all

  • Write

    Save a search

    Save a SuperSearch query for reuse. searchfilters uses the same shape as the count, preview and enrich endpoints. Requires one of the following scopes: supersearchenrichments:create, supersearchenrichments:all, all:create, all:all

  • Write

    Update a saved search

    Rename a saved search and/or replace its filters. Requires one of the following scopes: supersearchenrichments:update, supersearchenrichments:all, all:update, all:all

  • Destructive

    Delete a saved search

    Requires one of the following scopes: supersearchenrichments:delete, supersearchenrichments:all, all:delete, all:all

Campaign Subsequence

  • Read

    List campaign subsequence

    Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

  • Read

    Get subsequence analytics summary

    Returns per-subsequence engagement totals (emails sent, unique opens, unique replies) for the subsequences of a campaign. Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

  • Read

    Get campaign subsequence

    Requires one of the following scopes: subsequences:read, subsequences:all, all:read, all:all

  • Read

    Get subsequence step and variant analytics

    Returns engagement metrics grouped by zero-based step and variant for one subsequence. Results include only activity from the requested subsequence, excluding its parent campaign and sibling subsequences.

  • Read

    Get subsequence sending status

    Returns sending status data explaining why a subsequence may not be sending emails or is sending slower than expected. Note: Some fields may be missing when the campaign is out of schedule. Always-present fields: campaignid, subsequenceid, lastupdated, status, issuetracking.

  • Write

    Create campaign subsequence

    Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all

  • Write

    Duplicate a subsequence

    Duplicate a subsequence with the same trigger conditions Requires one of the following scopes: subsequences:create, subsequences:all, all:create, all:all

  • Write

    Pause a subsequence

    Pause a subsequence Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

  • Write

    Resume a paused subsequence

    Resume a paused subsequence Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

  • Write

    Patch campaign subsequence

    Requires one of the following scopes: subsequences:update, subsequences:all, all:update, all:all

  • Destructive

    Delete campaign subsequence

    Requires one of the following scopes: subsequences:delete, subsequences:all, all:delete, all:all

Email Verification

  • Read

    Check an email verification status

    Requires one of the following scopes: emailverifications:read, emailverifications:all, all:read, all:all

  • Write

    Create email verification

    If an email takes longer than 10 seconds to verify, the endpoint will return the status as pending. In that case, you may use the /email-verification/:email endpoint to check the status of the verification job.

Webhook Event

  • Read

    List webhook event

    Requires one of the following scopes: webhookevents:read, webhookevents:all, all:read, all:all

  • Read

    Get webhook event

    Requires one of the following scopes: webhookevents:read, webhookevents:all, all:read, all:all

  • Read

    Get overview aggregates for webhook events

    Get overview aggregates for webhook events including success/failure rates

  • Read

    Get overview aggregates for webhook events by date

    Get overview aggregates for webhook events by Date for charts

Webhook

  • Read

    List webhooks

    List all webhooks for the workspace with optional filters

  • Read

    Get webhook

    Requires one of the following scopes: webhooks:read, webhooks:all, all:read, all:all

  • Read

    List available event types

    Get all available webhook event types including custom labels

  • Write

    Create webhook

    Requires one of the following scopes: webhooks:create, webhooks:all, all:create, all:all

  • Write

    Patch webhook

    Requires one of the following scopes: webhooks:update, webhooks:all, all:update, all:all

  • Write

    Test a webhook

    Send a test payload to a webhook URL to verify it is working

  • Write

    Resume a webhook

    Resume a webhook that was disabled due to repeated delivery failures Requires one of the following scopes: webhooks:update, webhooks:all, all:update, all:all

  • Destructive

    Delete webhook

    Requires one of the following scopes: webhooks:delete, webhooks:all, all:delete, all:all

Workspace Billing

  • Read

    Get workspace plan details

    Requires one of the following scopes: workspacebilling:read, workspacebilling:all, all:read, all:all

  • Read

    Get workspace subscription details

    Requires one of the following scopes: workspacebilling:read, workspacebilling:all, all:read, all:all

Workspace Group Member

  • Read

    List workspace group member

    Requires one of the following scopes: workspacegroupmembers:read, workspacegroupmembers:all, all:read, all:all

  • Read

    Get workspace group member

    Requires one of the following scopes: workspacegroupmembers:read, workspacegroupmembers:all, all:read, all:all

  • Read

    Get the current workspace admin workspace

    Get the details of the admin workspace of the current workspace

  • Write

    Create workspace group member

    This endpoint allows you to send an invitation for a sub workspace to join the admin workspace. The sub workspace will be added as a sub workspace of the admin workspace only if the sub workspace owner accepts the invitation.

  • Destructive

    Delete workspace group member

    Requires one of the following scopes: workspacegroupmembers:delete, workspacegroupmembers:all, all:delete, all:all

Workspace Member

  • Read

    List workspace member

    Requires one of the following scopes: workspacemembers:read, workspacemembers:all, all:read, all:all

  • Read

    Get workspace member

    Requires one of the following scopes: workspacemembers:read, workspacemembers:all, all:read, all:all

  • Write

    Create workspace member

    Requires one of the following scopes: workspacemembers:create, workspacemembers:all, all:create, all:all

  • Write

    Patch workspace member

    Requires one of the following scopes: workspacemembers:update, workspacemembers:all, all:update, all:all

  • Destructive

    Delete workspace member

    Requires one of the following scopes: workspacemembers:delete, workspacemembers:all, all:delete, all:all

Workspace

  • Read

    Get workspace

    Get your current workspace details. Note that this endpoint doesn't require any parameters. It will return the workspace based on the API key sent in the headers. Requires one of the following scopes: workspaces:read, workspaces:all, all:read, all:all

  • Read

    Get organization verified agency domain information

    Requires one of the following scopes: workspaces:read, workspaces:all, all:read, all:all

  • Write

    Patch workspace

    Update your current workspace details. Note that this endpoint doesn't require any parameters. It will update the workspace based on the API key sent in the headers. Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

  • Write

    Schedule Current Workspace Removal

    Schedule the current workspace to be removed in 24 hours. Requires one of the following scopes: workspaces:delete, workspaces:all, all:delete, all:all

  • Write

    Set the agency domain for the workspace

    Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

  • Write

    Change workspace owner

    Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

  • Destructive

    Cancel Current Workspace Removal

    Requires one of the following scopes: workspaces:delete, workspaces:all, all:delete, all:all

  • Destructive

    Delete organization agency domain

    Requires one of the following scopes: workspaces:update, workspaces:all, all:update, all:all

AISales Agent

  • Read

    List AI Sales Agents

    List the AI Sales Agents of the workspace, newest first. Requires one of the following scopes: aisdr:read, aiagents:read, aisdr:all, all:read, all:all

  • Read

    Get an AI Sales Agent

    Retrieve a single AI Sales Agent with its full configuration. Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Read

    Get AI Sales Agent analytics

    Get daily analytics (leads found, emails sent, replies, opportunities, total email activity) merged across all campaigns of the AI Sales Agent. When startdate and enddate are omitted, the response covers all-time data.

  • Read

    Get AI Sales Agent opportunity summary

    Get aggregated opportunity counts by status and a per-campaign breakdown for all campaigns of the AI Sales Agent. When startdate and enddate are omitted, the response covers all-time data. Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Read

    Get research sources for an AI Sales Agent lead

    Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Read

    Get AI Sales Agent lead activity summary

    Get aggregate counts and rates for lead activity across all campaigns of the AI Sales Agent. When startdate and enddate are omitted, the response covers all-time data. Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Read

    List AI Sales Agent lead activity

    Get per-lead event history (emails sent, opens, replies, clicks, bounces, opportunity status) for all campaigns of the AI Sales Agent. Leads are ordered by email ascending and paginated with a cursor. When startdate and enddate are omitted, the response covers all-time data.

  • Read

    List AI Sales Agent activities

    List all activities for the AI Sales Agent. Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Read

    List AI Sales Agent guidance rules

    List the guidance rules the AI Sales Agent follows when writing outreach. An agent has at most 10 rules, so the list is not paginated. Requires one of the following scopes: aisdr:read, aisdr:all, all:read, all:all

  • Write

    Create an AI Sales Agent

    Create a new AI Sales Agent. Provide type and input to extract business details from a website or pitch deck, or skip the scrape by setting memoryfromworkspace to true to copy the workspace business details, or isduplicate with sourceaisdrid to copy an existing agent.

  • Write

    Update an AI Sales Agent

    Update an AI Sales Agent, including its configuration. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Write

    Approve an AI Sales Agent activity

    Approve a pending AI Sales Agent activity action. Approving a recommendautopilot activity turns on autopilot for the agent. Returns 404 when the activity does not exist or is not pending. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Write

    Reject an AI Sales Agent activity

    Reject a pending AI Sales Agent activity action. Returns 404 when the activity does not exist or is not pending. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Write

    Approve multiple AI Sales Agent activities

    Approve multiple pending AI Sales Agent activity actions. recommendautopilot activities are skipped: approve them one at a time. Returns 404 when none of the activities exist or none are pending. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Write

    Reject multiple AI Sales Agent activities

    Reject multiple pending AI Sales Agent activity actions. recommendautopilot activities are skipped: reject them one at a time. Returns 404 when none of the activities exist or none are pending. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Write

    Create an AI Sales Agent guidance rule

    Add a guidance rule the AI Sales Agent must follow when writing outreach. An agent can have at most 10 rules. Rules are stored as a single list, so concurrent writes to the same agent are last-write-wins — serialize them client-side.

  • Write

    Update an AI Sales Agent guidance rule

    Update the title or content of a guidance rule. Rules are stored as a single list, so concurrent writes to the same agent are last-write-wins — serialize them client-side. Requires one of the following scopes: aisdr:update, aisdr:all, all:update, all:all

  • Destructive

    Delete an AI Sales Agent

    Delete an AI Sales Agent. Returns the core fields of the deleted agent. Fails with a conflict while campaigns are still linked to the agent. Requires one of the following scopes: aisdr:delete, aisdr:all, all:delete, all:all

  • Destructive

    Delete an AI Sales Agent guidance rule

    Delete a guidance rule. Rule ids are positional, so the remaining rules re-index after a deletion — re-fetch the list before acting on another rule. Rules are stored as a single list, so concurrent writes to the same agent are last-write-wins — serialize them client-side.

AIInbox Manager

  • Read

    List AI Inbox Managers

    List the AI Inbox Managers of the workspace, newest first. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    Get an AI Inbox Manager

    Retrieve a single AI Inbox Manager with its full configuration. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    List AI Inbox Manager guidances

    List the guidances configured for an AI Inbox Manager. Requires one of the following scopes: aiagents:all, all:read, all:all

  • Read

    Get an AI Inbox Manager guidance

    Retrieve a single guidance of an AI Inbox Manager. Requires one of the following scopes: aiagents:all, all:read, all:all

  • Read

    List AI Inbox Manager replies

    List the replies and follow-ups generated by an AI Inbox Manager, newest first. Requires one of the following scopes: aisdrreplies:read, aiagents:all, all:read, all:all

  • Read

    Get an AI Inbox Manager reply

    Retrieve a single reply generated by an AI Inbox Manager, including its HTML body. Requires one of the following scopes: aisdrreplies:read, aiagents:all, all:read, all:all

  • Read

    Get AI Inbox Manager analytics summary

    Get aggregated analytics for an AI Inbox Manager over an optional date window. Requires one of the following scopes: aiinboxmanageranalytics:read, aiagents:all, all:read, all:all

  • Read

    Get AI Inbox Manager analytics by date

    Get daily analytics aggregates for an AI Inbox Manager over an optional date window. Requires one of the following scopes: aiinboxmanageranalytics:read, aiagents:all, all:read, all:all

  • Read

    List AI Inbox Manager activity

    Get the paginated unified activity feed (replies, follow-ups and no-show recoveries) for an AI Inbox Manager, newest first. Requires one of the following scopes: aiinboxmanageranalytics:read, aiagents:all, all:read, all:all

  • Write

    Create an AI Inbox Manager

    Create a new AI Inbox Manager with its configuration and optional initial guidance, saved together. The agent is created active. Including guidance also requires the guidance creation scope. Requires one of the following scopes: aiagents:create, aiagents:all, all:create, all:all

  • Write

    Update an AI Inbox Manager

    Update an AI Inbox Manager, including its configuration. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Create an AI Inbox Manager guidance

    Create a guidance for an AI Inbox Manager. The BASICS category is an upsert: it carries tone/length options instead of an instruction, is always active, and an agent has at most one — creating a second one updates the existing guidance in place.

  • Write

    Update an AI Inbox Manager guidance

    Update a guidance of an AI Inbox Manager. BASICS guidances keep an empty instruction and stay active; a guidance cannot be changed to or from the BASICS category. Requires one of the following scopes: aiagents:all, all:update, all:all

  • Write

    Update an AI Inbox Manager reply

    Update a reply generated by an AI Inbox Manager: leave feedback on the reply or mark its pending action as handled. Requires one of the following scopes: aisdrreplies:update, aiagents:all, all:update, all:all

  • Destructive

    Delete an AI Inbox Manager

    Delete an AI Inbox Manager. Returns the core fields of the deleted agent. Requires one of the following scopes: aiagents:delete, aiagents:all, all:delete, all:all

  • Destructive

    Delete an AI Inbox Manager guidance

    Delete a guidance of an AI Inbox Manager. Requires one of the following scopes: aiagents:all, all:delete, all:all

AILead Finder Agent

  • Read

    List AI Lead Finder Agents

    List the AI Lead Finder Agents of the workspace, newest first. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    Get an AI Lead Finder Agent

    Retrieve a single AI Lead Finder Agent with its full configuration. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    Get AI Lead Finder Agent lifetime stats

    Lifetime activity totals of an AI Lead Finder Agent. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    List AI Lead Finder Agent activities

    List the activity events of an AI Lead Finder Agent, newest first. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    List saved enrichment workflows

    Reusable AI-enrichment chains saved by the workspace, ready to apply to a Lead Finder Agent. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Write

    Create an AI Lead Finder Agent

    Create an AI Lead Finder Agent that keeps a campaign topped up with fresh leads. The agent immediately runs its first check after creation. Requires one of the following scopes: aiagents:create, aiagents:all, all:create, all:all

  • Write

    Update an AI Lead Finder Agent

    Update an AI Lead Finder Agent's settings. onexhaustion: fallback requires fallback filters, either in this request or already stored. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Pause an AI Lead Finder Agent

    Pause an AI Lead Finder Agent. A paused agent stops topping up its campaign until resumed. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Resume an AI Lead Finder Agent

    Resume a paused AI Lead Finder Agent. The agent immediately checks whether its campaign needs a top-up. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Suggest audiences from a campaign

    Analyze the leads already in a campaign and suggest SuperSearch audiences that match them. Each suggestion returns a natural-language query plus store-format filters. Rate limited per workspace. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Write

    Save an enrichment workflow

    Save an AI-enrichment chain as a named, workspace-wide reusable workflow. Requires one of the following scopes: aiagents:create, aiagents:all, all:create, all:all

  • Destructive

    Delete an AI Lead Finder Agent

    Delete an AI Lead Finder Agent. Leads it already added to the campaign stay in the campaign. Requires one of the following scopes: aiagents:delete, aiagents:all, all:delete, all:all

  • Destructive

    Delete a saved enrichment workflow

    Delete a saved workflow. Agents that already loaded it keep their copied chain. Requires one of the following scopes: aiagents:delete, aiagents:all, all:delete, all:all

AIDeliverability Agent

  • Read

    Get the default AI Deliverability Agent

    Retrieve the workspace default AI Deliverability Agent. The agent field is null if one has not been deployed. Use the returned agent.id with endpoints that require an agent ID. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    Get the default AI Deliverability Agent state

    Get the live state of the workspace default AI Deliverability Agent, including current activity, schedule, latest run summary, and activity feed. If no agent has been deployed, this endpoint returns an empty state with agent set to null.

  • Read

    Get an AI Deliverability Agent

    Retrieve a single AI Deliverability Agent. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    Get AI Deliverability Agent state

    Get the live state of an AI Deliverability Agent: current activity, schedule, latest run summary, and the activity feed. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Read

    List AI Deliverability Agent feed items

    List the activity-feed items of an AI Deliverability Agent, newest first. Requires one of the following scopes: aiagents:read, aiagents:all, all:read, all:all

  • Write

    Update the default AI Deliverability Agent settings

    Update Slack notification settings for the workspace default AI Deliverability Agent. Set slack to null to disconnect Slack notifications. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Pause accounts affected by a deliverability recommendation

    Pause active email accounts currently affected by the default agent's DNS-health or blocklist recommendation. The recommendation is revalidated before account statuses are changed. Calling this endpoint for an already completed feed item is idempotent.

  • Write

    Pause campaign sending for affected accounts

    Pause campaign sending for 14 days on self-managed accounts affected by the default agent's bounce-health or warmup-score recommendation. Calling this endpoint for an already completed feed item is idempotent.

  • Write

    Complete a Deliverability Agent feed item

    Mark a supported pending recommendation complete after the default agent verifies that its underlying issue has been resolved. Currently, workspace-settings recommendations support manual completion. Calling this endpoint for an already completed feed item is idempotent.

  • Write

    Run Deliverability Agent now

    Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Write

    Deploy the default AI Deliverability Agent

    Create or reactivate the workspace default AI Deliverability Agent. This operation is idempotent when the agent is already active and schedules an initial cycle after deployment. Requires one of the following scopes: aiagents:create, aiagents:all, all:create, all:all

  • Write

    Update an AI Deliverability Agent

    Update an AI Deliverability Agent. Set slack to connect Slack notifications, or to null to disconnect them. Requires one of the following scopes: aiagents:update, aiagents:all, all:update, all:all

  • Destructive

    Delete an AI Deliverability Agent

    Delete an AI Deliverability Agent, removing its activity history and any queued runs. Returns the core fields of the deleted agent. Deploying again creates a fresh agent. Requires one of the following scopes: aiagents:delete, aiagents:all, all:delete, all:all

Company List

  • Read

    List company-list recipes

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    List company-list sources

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Get remote filter options for a catalog-backed company-list filter

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    List company lists

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    Get company-list status

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Read

    List company-list members

    Requires one of the following scopes: supersearchenrichments:read, supersearchenrichments:all, all:read, all:all

  • Write

    Create a company list build

    Requires one of the following scopes: supersearchenrichments:create, supersearchenrichments:all, all:create, all:all

  • Write

    Rename a terminal company list

    Requires one of the following scopes: supersearchenrichments:update, supersearchenrichments:all, all:update, all:all

  • Destructive

    Delete a terminal company list

    Requires one of the following scopes: supersearchenrichments:delete, supersearchenrichments:all, all:delete, all:all

See How connections work for access and permissions, or browse all integrations.

Reference date: October 27, 2026. Instantly API docs.