Skip to content

Customize Referral Code

Use this API to customize referral code to a particular User.

POSTapi.appvirality.com/v2_0/customizereferralcodeapplication/json

Input i.e. Request

{
"apikey": "7ffdda00fd5c4338a9c1a44e00663648",
"privatekey": "d1e881dc60fa4856be34a44f00d96c9a",
"userkey": "588d87d8d9e89ac5d710caf68910ac5d",
"EmailId": "",
"UserIdInstore": "",
"customreferralcode": "saas123"
}

Input Params

Input ParamsDescription
apikeyAPI Key of the App
Get it from DashboardApp Details
privatekeyPrivate key for API requests
Get it from: DashboardApp Details › Click App Settings › Scroll down to Advanced Settings
userkey
(conditional)
User Key for the App user - a unique identifier for every App User recorded
EmailId
(conditional)
Email of the User, updated to AppVirality
UserIdInstore
(conditional)
Store Id of the App user, updated to AppVirality - a unique identifier of the user in your App
customreferralcodeReferral code you want to update to an user

conditional - One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId


Response

{
"success":true,
"statuscode": 1,
"message":"Success"
}

Response Params

Output ParamsDescription
successreturns true on successful modification of referral code
messageInformation regarding API call (if relevant)
status codecode based on status of the API call

Status codes which you will see while using Customize Referral Code API

Status codes and description for API responses

Status CodeDescription
0No data found for the search criteria
1Success
2Invalid User Key
5Invalid StoreID or EmailID
61Referrer Code already exists