CLclose
field_enrichment

Enrich a specific field on a lead or contact using AI

Changed on

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

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/enrich_field/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

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

Changes

  • 2ff98656cc2aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status