Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
SuperSearchEnrichment

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

post/api/v2/supersearch-enrichment/run

Request body

resource_idstring uuid required

The ID of the resource (list or campaign) to run enrichments for

lead_idsstring[]

List of lead IDs to enrich (optional)

limitinteger

If set, only the first N leads will be enriched

column_namestring

AI enrichment column to run.

overwriteboolean

(AI re-run parameter) If true, run even if column has value. If false (default), only process empty/null columns. Requires column_name.

starting_rowinteger

(AI re-run parameter) Starting lead position (inclusive, 1-indexed). Defaults to 1 if not provided. Requires column_name.

countinteger

(AI re-run parameter) How many leads to process. If not provided, processes all remaining leads from starting_row to the end. Requires column_name.

Example request

{
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "lead_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "limit": 10,
  "column_name": "email_subject",
  "starting_row": 1,
  "count": 10,
  "filters": [
    {
      "column_name": "companyName",
      "type": 1,
      "value": [
        "Acme"
      ]
    }
  ]
}

Response

Default Response

idstring

The ID of the enrichment

resource_idstring

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

enrichment_payloadobject

The payload of the enrichment

Example response

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