Skip to content

Redeem referral code

POST
/api/v1/revenue/referral/redeem

Redeem a referral code for a new user.

Authorizations

Request Body required

Request body for referral code redemption.

Attributes: code: The referral code to redeem. email: Email of the new user being referred.

object
code
required

Referral code

string
>= 1 characters
email
required

Referee email

string
>= 1 characters

Responses

201

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string