API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Servers

Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

Operations

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

SuperSearch Enrichment

A SuperSearch enrichment that retrieves and enriches leads based on search filters

Operations

SuperSearch Enrichment

A SuperSearch enrichment that retrieves and enriches leads based on search filters

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Create supersearch enrichment

Request

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

Bodyapplication/jsonrequired

The SuperSearch Enrichment to create

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idstring or null

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnumber or null

The maximum number of leads to enrich

Example: 100

resource_idstring or null(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namestring or null

The name of the search

Example: "CEO of tech companies in San Francisco"

list_namestring or null

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsboolean or null

Whether the enrichment exists

Example: true

auto_updateboolean or null

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailboolean or null

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressboolean or null

Whether the enrichment is in progress

Example: false

curl -i -X POST \
  https://api.instantly.ai/api/v2/supersearch-enrichment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrichment_payload": {}
  }'

Responses

The SuperSearch Enrichment

Bodyapplication/json

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

Response

application/json

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Get supersearch enrichment

Request

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

Path

resource_idstring(uuid)required

The ID of the list or campaign to retrieve the enrichment.

Example: 123e4567-e89b-12d3-a456-426614174000

curl -i -X GET \
  https://api.instantly.ai/api/v2/supersearch-enrichment/123e4567-e89b-12d3-a456-426614174000 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested SuperSearch Enrichment

Bodyapplication/json

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

Response

application/json

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Add supersearch enrichment to resource

Request

Path

resource_idstring(uuid)required

Unique identifier for the resource (list or campaign)

Example: 01234567-89ab-cdef-0123-456789abcdef

Bodyapplication/jsonrequired

typestringrequired

Enrichment type

Enum Value	Description
work_email_enrichment	Work Email Enrichment
fully_enriched_profile	LinkedIn Enrichment
email_verification	Email Verification
joblisting	Job Listing Enrichment
technologies	Technologies Enrichment
news	News Enrichment
funding	Funding Enrichment

Example: "email_verification"

resource_idstring(uuid)

Unique identifier for the entity to import leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

auto_updateboolean

Whether the enrichment is auto-updated

Example: true

skip_rows_without_emailboolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

limitnumber[ 1 .. 50000 ]

Maximum number of leads to enrich.

Example: 100

curl -i -X POST \
  https://api.instantly.ai/api/v2/supersearch-enrichment/01234567-89ab-cdef-0123-456789abcdef/add \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "email_verification"
  }'

Responses

The requested SuperSearch Enrichment

Bodyapplication/json

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

Response

application/json

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Create AI enrichment

Request

Bodyapplication/jsonrequired

resource_idstring(uuid)required

Id of the resource (list or campaign) to enrich

Example: "01234567-89ab-cdef-0123-456789abcdef"

output_columnstringrequired

Name of the column where the AI enrichment results will be stored

Example: "ai_generated_content"

resource_typenumberrequired

Type of the entity to enrich

Enum Value	Description
1	Campaign
2	List

Example: 2

model_versionstringrequired

Version of the AI model to use for enrichment. Different models have different capabilities, costs, and token limits.

Enum Value	Description
3.5	GPT-3.5 Turbo - OpenAI's standard model with good performance and low cost
gpt-5	GPT-5 is OpenAI’s most advanced model, offering major improvements in reasoning, code quality, and user experience.
gpt-5-mini	GPT-5 Mini is a compact version of GPT-5, designed to handle lighter-weight reasoning tasks.
gpt-5-nano	GPT-5-Nano is the smallest and fastest variant in the GPT-5 system, optimized for developer tools, rapid interactions, and ultra-low latency environments.
4.0	GPT-4 - OpenAI's advanced model with improved reasoning
gpt-4o	GPT-4o - OpenAI's optimized model with improved performance
o3	o3 is a well-rounded and powerful model across domains. It sets a new standard for math, science, coding, and visual reasoning tasks.
gpt-4.1	GPT-4.1 is a flagship large language model optimized for advanced instruction following, real-world software engineering, and long-context reasoning.
claude-3.7-sonnet	Claude 3.7 Sonnet - Anthropic's most capable model
claude-3.5-sonnet	Claude 3.5 Sonnet - Anthropic's balanced model

Example: "gpt-4o"

input_columnsArray of strings

List of column names to use as input data for the AI enrichment. These are the fields from your leads that will be used to generate content.

Example: ["first_name","last_name","email","company_name","job_title","location"]

use_instantly_accountboolean

When true, the enrichment will use Instantly's account for API calls. When false, it will use your own API keys configured in settings.

Example: true

overwriteboolean

When true, will overwrite existing values in the output column. When false, only empty fields will be enriched.

Example: false

auto_updateboolean

When true, new leads added to the campaign/list will be automatically enriched using these same settings.

Example: true

skip_leads_without_emailboolean

When true, leads without an email will be skipped.

Example: false

limitnumber[ 1 .. 50000 ]

Maximum number of leads to enrich.

Example: 100

promptstring

Custom prompt to guide the AI enrichment. Use {{variables}} to reference input data. Only used when templateId is not provided.

Example: "Write a personalized email to {{first_name}} from {{company_name}} about our new product"

template_idnumber

ID of a predefined AI prompt template to use instead of a custom prompt. Templates are reusable prompt configurations.

Example: 123

statusnumber

Status of the job

Enum Value	Description
1	Job is pending processing
2	Job is currently being processed
3	Job has been completed successfully
4	Job processing failed

Example: 1

curl -i -X POST \
  https://api.instantly.ai/api/v2/supersearch-enrichment/ai \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
    "output_column": "ai_generated_content",
    "resource_type": 2,
    "model_version": "gpt-4o"
  }'

Responses

The requested SuperSearch Enrichment

Bodyapplication/json

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

Response

application/json

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Get enrichment history

Request

Retrieve the enrichment history for a specific resource

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

Path

resource_idstring(uuid)required

ID of the resource to retrieve

Example: 123e4567-e89b-12d3-a456-426614174000

Query

offsetnumber

Example: offset=0

limitnumber

Example: limit=10

curl -i -X GET \
  'https://api.instantly.ai/api/v2/supersearch-enrichment/history/123e4567-e89b-12d3-a456-426614174000?limit=10&offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested SuperSearch Enrichment

Bodyapplication/json

enrichment_payloadobjectnon-emptyrequired

Object with enrichment types to be applied, with boolean values

enrichment_payload.work_email_enrichmentboolean

Example: true

enrichment_payload.fully_enriched_profileboolean

Example: true

enrichment_payload.email_verificationboolean

Example: false

enrichment_payload.joblistingboolean

Example: true

enrichment_payload.technologiesboolean

Example: true

enrichment_payload.newsboolean

Example: true

enrichment_payload.fundingboolean

Example: true

idnull or string

Unique identifier for the enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

search_filtersobject

Criteria that determine which leads are enriched

limitnull or number

The maximum number of leads to enrich

Example: 100

organization_idnull or string(uuid)read-only

Organization ID that created this enrichment

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_idnull or string(uuid)

Unique identifier for the entity to enrich leads into

Example: "01234567-89ab-cdef-0123-456789abcdef"

resource_typenumber

Type of the entity to enrich leads into

Enum Value	Description
1	Campaign
2	List

Example: 1

search_namenull or string

The name of the search

Example: "CEO of tech companies in San Francisco"

job_idnull or string(uuid)read-only

Unique identifier for the enrichment job created

Example: "01234567-89ab-cdef-0123-456789abcdef"

list_namenull or string

Custom name for the list created during enrichment

Example: "My SuperSearch List"

existsnull or boolean

Whether the enrichment exists

Example: true

auto_updatenull or boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example: true

skip_rows_without_emailnull or boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example: true

in_progressnull or boolean

Whether the enrichment is in progress

Example: false

Response

application/json

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "search_filters": {
    "locations": [ … ],
    "department": [ … ],
    "level": [ … ],
    "employeeCount": [ … ],
    "revenue": [ … ],
    "news": [ … ],
    "title": { … },
    "name": [ … ],
    "companyName": { … },
    "lookAlike": "google.com",
    "keywordFilter": { … },
    "industry": { … },
    "domains": [ … ],
    "fundingType": [ … ],
    "skipOwnedLeads": true,
    "showOneLeadPerCompany": true
  },
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "email_verification": false,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true
  },
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "search_name": "CEO of tech companies in San Francisco",
  "job_id": "01234567-89ab-cdef-0123-456789abcdef",
  "list_name": "My SuperSearch List",
  "exists": true,
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": false
}

Run an enrichment

Request

Run an enrichment for a list of leads or for all the leads that haven't been enriched yet

Bodyapplication/jsonrequired

enrichment_idstringrequired

The ID of the enrichment

Example: "123e4567-e89b-12d3-a456-426614174000"

lead_idsArray of strings[ 1 .. 10000 ] items

List of lead IDs to enrich

Example: ["123e4567-e89b-12d3-a456-426614174000"]

enrichment_typestring

The type of enrichment to run

Example: "work_email_enrichment"

limitinteger

If set, only the first N leads will be enriched

Example: 10

curl -i -X POST \
  https://api.instantly.ai/api/v2/supersearch-enrichment/run \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrichment_id": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Default Response

Bodyapplication/json

idstring

The ID of the enrichment

Example: "123e4567-e89b-12d3-a456-426614174000"

resource_idstring

The ID of the resource (list or campaign) to enrich

Example: "123e4567-e89b-12d3-a456-426614174000"

enrichment_payloadobject

The payload of the enrichment

Response

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "enrichment_payload": {}
}

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Filter

A filter that can be applied to variables in campaigns or lists

Audit Log

Audit log records for tracking system activities

Operations

Webhook

A webhook subscription for receiving event notifications

Operations

API Explorer (2.0.0)

Analytics

Account

Campaign

Email

Email Verification

Lead List

Inbox Placement Test

Inbox Placement Analytics

Inbox Placement Blacklist & SpamAssassin Report

API Key

Account Campaign Mapping

Lead

Background Job

Custom Tag

Block List Entry

Lead Label

Workspace

SuperSearch Enrichment

SuperSearch Enrichment

Create supersearch enrichment

RequestExpand all

Responses

Was this helpful?

Get supersearch enrichment

Request

Responses

Was this helpful?

Add supersearch enrichment to resource

Request

Responses

Was this helpful?

Create AI enrichment

Request

Responses

Was this helpful?

Get enrichment history

Request

Responses

Was this helpful?

Run an enrichment

Request

Responses

Was this helpful?

Workspace Group Member

Workspace Member

Campaign Subsequence

Filter

Audit Log

Webhook

Schemas

Request