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.

token
string
required

Signed, time-limited preference token bound to this email and brand.

preferences
object
required

Email topic choices. Transactional lifecycle messages remain enabled.

locale
string

Preferred email language; unsupported values fall back to English.

Response

Successful response.

ok
boolean

Whether the requested marketing action was accepted.

preferences
object

Email topic choices. Transactional lifecycle messages remain enabled.