Skip to main content
POST
/
api
/
v2
/
supersearch-enrichment
Create an enrichment
curl --request POST \
  --url https://api.instantly.ai/api/v2/supersearch-enrichment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "type": "email_verification"
}
'
{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "limit": 100,
  "enrichment_payload": {
    "joblisting": true,
    "email_verification": true,
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "custom_flow": [
      "instantly"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
resource_id
string<uuid>
required

Unique identifier for the resource (list or campaign)

Example:

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

​
type
enum<string>
required

Enrichment type to add to the resource

Available options:
work_email_enrichment,
fully_enriched_profile,
email_verification,
joblisting,
technologies,
news,
funding,
ai_enrichment,
custom_flow
Example:

"email_verification"

​
limit
number

Maximum number of leads to enrich.

Required range: 1 <= x <= 50000
Example:

100

​
filters
object[]

Filters to apply to the enrichment

​
custom_flow
string[]

Custom flow to apply to the enrichment

Response

Default Response

​
id
string
required

Unique identifier for the enrichment

Example:

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

​
organization_id
string<uuid>
required

Organization ID that created this enrichment

Example:

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

​
resource_id
string<uuid>
required

Unique identifier for the entity to enrich leads into

Example:

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

​
limit
number

The maximum number of leads to enrich

Example:

100

​
enrichment_payload
object

The enrichment configuration payload