Field Enrichment
Field Enrichment uses AI to intelligently populate fields on leads and contacts.
The Field Enrichment API waits for the enrichment process to complete before returning a response. Fields with complex guidance or requirements may time out / not complete. If this happens consistently, try to simplify the instructions or reduce the scope of the request.
Supported Field Types
The Field Enrichment API works with various custom field types:
- Text Fields: Company descriptions, job titles, notes
- Choice Fields: Industry categories, lead sources, priorities
- Number Fields: Employee counts, revenue estimates, scores
- Date Fields: Founded dates, last contact dates
- Multi-Choice Fields: Tags, categories, services offered
For best results, configure guidance for each field within the field settings in the Close app.
Update Strategy
By default, values are saved but only if the field does not already
have a value. Saving values may be disabled by specifying
set_new_value: false
in the request, or enrichment can be set to
overwrite any existing values by specifying
overwrite_existing_value: true
.
Enrich a specific field on a lead or contact using AI.
POST /enrich_field/
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 IDobject_type
(required): Either "lead" or "contact"object_id
(required): The ID of the lead or contact to enrichfield_id
(required): The ID of the custom field to enrichset_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)