Skip to main content
POST
/
rewards
/
referrals
Create referral
curl --request POST \
  --url https://api.sprucecollective.co.uk/rewards/referrals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referee_user_id": "<string>",
  "referral_code": "<string>"
}
'
{
  "created_at": "<string>",
  "id": "<string>",
  "is_cancelled": true,
  "is_completed": true,
  "referee_user_id": "<string>",
  "referral_code": "<string>",
  "referrer_user_id": "<string>",
  "site_id": "<string>",
  "status": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Body

application/json

Referral data

referee_user_id
string
required
referral_code
string

Response

Created

created_at
string
id
string
is_cancelled
boolean
is_completed
boolean
referee_user_id
string
referral_code
string
referrer_user_id
string
site_id
string
status
string
updated_at
string