HomeAppVirality DocsAppVirality APIsCustomize Referral Code

Customize Referral Code

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


Base URL  https://api.appvirality.com

 POST         /v2_0/customizereferralcode

Content-Type application/json

Input i.e. Request

"apikey": "7ffdda00fd5c4338a9c1a44e00663648",
"privatekey": "d1e881dc60fa4856be34a44f00d96c9a",
"userkey": "588d87d8d9e89ac5d710caf68910ac5d",
"EmailId": "",
"UserIdInstore": "",
"customreferralcode": "saas123"
Input Params
Input Params Description
apikey API Key of the App
Get it from Dashboard >> App Details
privatekey Private key for API requests
Get it from: Dashboard >> App Details >> Click App Settings >> Scroll down to Advanced Settings
User Key for the App user – a unique identifier for every App User recorded
Email of the User, updated to AppVirality
Store Id of the App user, updated to AppVirality – a unique identifier of the user in your App
customreferralcode Referral 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



"statuscode": 1,
Response Params
Output Params Description
success returns true on successful modification of referral code
message Information regarding API call (if relevant)
status code code 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 Code Description
0 No data found for the search criteria
1 Success
2 Invalid User Key
5 Invalid StoreID or EmailID
61 Referrer Code already exists
Was this article helpful to you? Yes No 1