Applies the referral code to a user

Applies the referral code to the user.

post

Path parameters

idstringRequired

The id of the user who is applying the referral code.

Query parameters

referralCodestringRequired

The referral code to apply.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

400

The referral code is not valid. Please enter a valid referral code.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

404

The user was not found in the database.

application/json

429

The user has exceeded the rate limit.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/referrals/apply HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": true,
  "errors": []
}