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

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

databooleanOptional

400

The referral code is invalid. 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 system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/users/{id}/referrals/apply

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/referrals/apply?referralCode=text 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": []
}