Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
SuperSearchEnrichment

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: supersearch_enrichments:create, supersearch_enrichments:all, all:create, all:all

patch/api/v2/supersearch-enrichment/{resource_id}/settings

Path parameters

resource_idstring uuid required
Example:01234567-89ab-cdef-0123-456789abcdef

Unique identifier for the resource (list or campaign)

Request body

auto_updateboolean

Whether new leads added to the resource will be automatically enriched

skip_rows_without_emailboolean

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

is_evergreenboolean

Whether the enrichment is evergreen

Example request

{
  "auto_update": true,
  "skip_rows_without_email": true,
  "is_evergreen": true
}

Response

The requested SuperSearch Enrichment

idstring required

Unique identifier for the enrichment

limitnumber nullable

The maximum number of leads to enrich

organization_idstring uuid required

Organization ID that created this enrichment

enrichment_payloadobject

Enrichment payload

auto_updateboolean nullable

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

skip_rows_without_emailboolean nullable

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

in_progressboolean nullable

Whether the enrichment is in progress

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

resource_idstring uuid required

Unique identifier for the entity to enrich leads into

resource_type1 | 2 required

Type of the entity to enrich leads into

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "limit": 100,
  "organization_id": "01234567-89ab-cdef-0123-456789abcdef",
  "auto_update": true,
  "skip_rows_without_email": true,
  "in_progress": true,
  "type": "email_verification",
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1
}