latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

field_enrichment

Enrich a specific field on a lead or contact using AI

This endpoint uses AI to enrich (populate or enhance) a specific field on a lead or contact. The enrichment process analyzes existing data and external sources to provide intelligent field values.

Parameters:

  • organization_id (required): The organization ID
  • object_type (required): Either "lead" or "contact"
  • object_id (required): The ID of the lead or contact to enrich
  • field_id (required): The ID of the custom field to enrich
  • set_new_value (optional): Whether to update the field with the enriched value (default: true)
  • overwrite_existing_value (optional): Whether to overwrite existing field values (default: false)
post/enrich_field/

Request body

field_idstring required
object_idstring required
object_type'lead' | 'contact' required
organization_idstring required
overwrite_existing_valueboolean
set_new_valueboolean

Response

Successful response