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

The body is of type object.

Response

Successful response.

referral_code
string
required

Referral code of this account.

Maximum string length: 20
is_active
boolean
required

Whether the referral profile is active.

commission_rate_bps
integer
required

Commission rate in basis points; 100 basis points is one percent.

Required range: x >= 0
discount_bps
integer
required

Referral discount in basis points.

Required range: x >= 0
totals
object
required

Totals for this referral summary.