Skip to main content
POST
Enrich contacts with an AI custom field

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer
required

Custom field ID

Body

application/json
contactIds
integer[] | null

The contacts to enrich, up to 1000 per call. Omit the property entirely to enrich every contact you own, as far as your credits reach. An empty array is rejected.

Required array length: 1 - 1000 elements
Required range: x >= 1
overrideExistingData
boolean
default:false

When false, contacts that already hold a value for the field are skipped. Set it to true to regenerate those values as well.

Response

Enrichment queued

The queued enrichment run. Poll GET /v3/background-jobs/{jobId} for its progress and final status.

jobId
string<uuid>
required

Background job covering the run.

contactsAccepted
integer
required

Contacts accepted for enrichment.

enrichmentsQueued
integer
required

Enrichments queued across those contacts.