Enrich a specific field on a lead or contact using AI

POST

https://api.close.com/api/v1/enrich_field/

POST

/api/v1/enrich_field/

curl -X POST https://api.close.com/api/v1/enrich_field/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "field_id": "cf_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "object_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "overwrite_existing_value": false,
  "set_new_value": true
}'

{
  "confidence": "high",
  "field_id": "cf_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "object_id": "lead_s6vHFTK1TSRoH6otXOexWDO9jM4xyb1kELHDoU7Fdsp",
  "object_type": "lead",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "reasoning": "Based on the company's website content and existing lead information, this appears to be a software development company specializing in CRM solutions.",
  "value": "Software Development"
}

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)

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

field_idstringRequired

object_idstringRequired

object_typeenumRequired

Allowed values:

organization_idstringRequired

overwrite_existing_valuebooleanOptionalDefaults to false

set_new_valuebooleanOptionalDefaults to true

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error