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.

Maximum string length: 254

Explicit newsletter opt-in. The endpoint requires the boolean true.

Available options:
true
locale
string

Preferred email language; unsupported values fall back to English.

Response

Successful response.

ok
boolean

Whether the requested marketing action was accepted.

contactId
string | null

Provider contact identifier when the best-effort contact upsert returns one; otherwise null.

status
enum<string>

Newsletter subscription state; successful requests return subscribed.

Available options:
subscribed