Referral Endpoints
Update Referral
Updates a referral based on their ID
PUT
/
referrals
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
referralId
string
requiredThe referral ID to update
name
string
Name of the referred user
email
string
Email of the referred user
referredUserExternalId
string
The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)
plan
string
The plan associated with the referred user
status
string
Status of the referral (active/inactive)