Referrals

Search…

Referrals

The referral object
Attribute
Type
Description
id
uuid
The unique identifier for the request.
code
string
The referral code.
expires_at
time
The time when the referral code expires.
Example
{
    "id": "dc7b0133-71ed-43b1-9e30-f6c873d61987",
    "code": "ABC-123-DEFG",
    "expires_at": "2017-09-04T12:26:43.398646Z"
}
Create a referral code
Request
Response
POST /v1/referrals
Attribute
Type
Description
email
string
The email which an invite will be sent to, if specified.
phone
string
The phone number which an invite will be sent to, if specified.
{
    "email": "[email protected]"
}
201 Created
Returns a referral object.
Redeem referral code
Request
Response
POST /v1/referrals/redeem/{code}
200 OK
Returns a referral object.
404 Not Found
Code wasn't found or has already been redeemed.

Receipts

Requests

Last modified 1yr ago

Copy link

Outline

The referral object

Example

Create a referral code

Redeem referral code