Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

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

Headers

X-Brand-Slug
string

Brand for this request; use hi-doctor for these examples.

Body

application/json
email
string<email>
required

Email address of the patient or recipient, normalized by the endpoint.

subject_slug
string
required

Stable medicine or condition slug identifying the waitlist interest.

subject_display_name
string
required

Subject name shown in the waitlist confirmation email.

locale
string

Preferred email language; unsupported values fall back to English.

category
string

Treatment category associated with the waitlist signup.

funnel
string

Acquisition funnel associated with the waitlist signup.

source
string

Acquisition source recorded for the waitlist signup.

city
string

City display name recorded for the waitlist signup.

city_slug
string

Stable city slug recorded for the waitlist signup.

country
string

Country associated with the waitlist signup.

subject_kind
enum<string>

Waitlist subject kind; defaults to medicine.

Available options:
medicine,
condition

Response

Successful response.

ok
boolean
required

Whether the request was accepted.

id
string<uuid>
required

Identifier of the stored waitlist interest.

created
boolean
required

True for a new interest; false for an updated email and subject.

contactId
string | null
required

Provider contact identifier returned by the best-effort upsert.

subjectKind
enum<string>
required

Normalized subject kind.

Available options:
medicine,
condition
subjectSegmentId
string | null
required

Configured waitlist audience identifier for this locale.

medicineSegmentId
string | null
required

Compatibility alias of subjectSegmentId.