Skip to main content
POST
Enrich Contact
Queues an email and/or mobile phone enrichment for a contact. This endpoint always returns immediately with a PENDING job — poll Enrichment Status with the returned enrichmentId to get the result.
Enriching costs credits - see the Credit usage section

Request

Path

string
required
Obfuscated companyId returned by the search endpoint.
string
required
ContactId is the unique identifier of the contact.

Body

boolean
default:"false"
Enrich the contact with an email address, if available.
boolean
default:"false"
Enrich the contact with a mobile phone number, if available.
At least one of enrichEmail or enrichMobilePhone must be true.

Response

Returns 202 Accepted with a Location header pointing at /enrichments/{enrichmentId}.
When the enrichment resolves synchronously (nothing to queue) and a credit is charged, the response includes X-Bizzy-Credits-Balance and X-Bizzy-Credits-Charged headers — see Credit usage.
string
Obfuscated id used to poll the Enrichment Status endpoint.
string
Always PENDING on creation.