INinstantly
SuperSearchEnrichment

Create an enrichment

Changed on

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. A custom_flow type requires custom_flow: a non-empty list of distinct email provider ids, spelled exactly as listed on that field. An empty list, a repeated id or any other value is refused with a 400 that names each invalid entry and the valid ids.

post/api/v2/supersearch-enrichment/

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/supersearch-enrichment/
  • Auth
    HTTP bearer

Request body

resource_idstring uuid required

Unique identifier for the resource (list or campaign)

type'work_email_enrichment' | 'fully_enriched_profile' | 'email_verification' | 'joblisting' | 'technologies' | 'news' | 'funding' | 'engagement_score' | 'ai_enrichment' | 'custom_flow'

Enrichment type to add to the resource

limitnumber

Maximum number of leads to enrich.

filtersobject[]

Filters to apply to the enrichment

custom_flowstring[]

Ordered email providers for a custom_flow enrichment. Required when type is custom_flow; ignored for every other type. A non-empty list of distinct ids, each spelled exactly as one of: instantly, findymail, leadmagic, icypeas, prospeo, contactout, wiza, bettercontact.

integration_actionsobject

Provider-keyed integration actions to run against the resource. Mutually exclusive with type — either run a built-in enrichment via type or supply integration_actions to run one or more provider actions. Outer keys are provider IDs (e.g. findymail, apify); inner keys are action IDs offered by that provider (e.g. findymail_find_email). Each action requires a mapping object whose keys are the action's declared input fields and whose values are the lead column names to read from.

Example request

{
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "type": "email_verification",
  "limit": 100,
  "custom_flow": [
    "instantly"
  ],
  "integration_actions": {
    "findymail": {
      "findymail_find_email": {
        "mapping": {
          "first_name": "firstName",
          "last_name": "lastName",
          "domain": "website"
        }
      }
    }
  }
}

Response

Default Response

idstring required

Unique identifier for the enrichment

job_idstring nullable

Identifier of the enrichment job scheduled by this request. null when no job was scheduled.

limitnumber

The maximum number of leads to enrich

organization_idstring uuid required

Organization ID that created this enrichment

resource_idstring uuid required

Unique identifier for the entity to enrich leads into

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "job_id": "12345",
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "enrichment_payload": {
    "joblisting": true,
    "email_verification": true,
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "custom_flow": [
      "instantly"
    ]
  }
}

Changes

  • c781051105a8Revision changes
    • breaking

      added subschema #1 to the request body allOf list

    • info

      the request property's max was increased from 50000.00 to 1000000.00

    • info

      added the optional property to the response with the status