Skip to main content
POST
Preview Cohort Custom Contacts

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Raw, client-tokenized contact list. The server owns all classification.

contacts
string[]

Response

Successful Response

Server-authoritative classification of a custom contact list.

custom_list is the normalized value the client persists on the cohort — not its own parse. matched_count counts patients; unmatched lists valid contacts that resolved to no patient (distinct concepts for UI copy).

customList
CustomListFilters · object
required

Normalized contact-list filters for custom-list cohorts.

emails/phone_numbers are normalized and deduped at the boundary by the shared contact_list helpers, so a write re-normalizes idempotently regardless of how the values arrived (client preview output, stored JSONB).

matchedCount
integer
required
totalInput
integer
required
droppedInvalid
string[]
unmatched
string[]
samplePatients
CustomContactsPreviewPatient · object[]