Api reference
Apply Referral Code
Apply a referral code when a new member signs up
POST
/referrals/applyApply a referral code when a new member signs up
AuthorizationBearer <token>
Use your private API key (sk_xxx) as the bearer token
In: header
Request Body
application/json
externalId*string
New member's external ID
referralCode*string
The referral code to apply
email?string
Format
emailname?string
Response Body
application/json
curl -X POST "https://app.useloyalty.app/api/v1/referrals/apply" \ -H "Content-Type: application/json" \ -d '{ "externalId": "new_user_456", "referralCode": "REF-A7X9K2", "email": "newuser@example.com", "name": "Jane Smith" }'{
"success": true,
"referral": {},
"member": {
"id": "string",
"externalId": "string",
"email": "user@example.com",
"name": "string",
"avatarUrl": "http://example.com",
"points": 0,
"totalPointsEarned": 0,
"currentStreak": 0,
"longestStreak": 0,
"metadata": {},
"createdAt": "2019-08-24T14:15:22Z"
},
"rewardsAwarded": {}
}Empty
Empty