Invokeoutreach
Use this api to trigger the outreach email in saas referrals.
You have to send userkey or emailId or UserIdInstore in the api request to trigger outreach email.
Base URL https://api.appvirality.com
POST /saas/v1_0/invokeoutreach
Content-Type application/json
Input i.e. Request
{
"apikey":"176502556c624614b913a62400ab4d7e",
"privatekey":"8b05ee42d9c941698bbba44c00cc32d1",
"userkey": "176502556c624614b913a62400ab4d7e",
"emailId":"xxxrahulxxx@gmail.com",
"UserIdInstore":"f45d2318de",
"AppUserName":"Rahul",
"ProfileImage":"[Image URL]",
"city":"Hyderabad",
"state":"Telangana",
"country":"India",
"Phone":""
}
| 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 |
| userkey (conditional) |
User Key for the App user – a unique identifier for every App User recorded |
| EmailId (conditional) |
Email of the user |
| UserIdInstore (conditional) |
ID of the user in your App (helps to identify users on dashboard as you do in your app) |
| AppUserName (optional) |
Name of the App user (is required to personalize the referral messages) If the name consists of special characters, then send the content in URI encoded format. |
| ProfileImage (optional) |
User profile picture URL (required to personalize the referral messages) |
| city (optional) |
City of the User Location |
| state (optional) |
State of the User Location |
| country (optional) |
Country of the User Location |
| Phone (optional) |
User phone number (Digits only) |
Response
{
"userkey": "176502556c624614b913a62400ab4d7e",
"shareurl": "http://apvi.co/sure1zh-14l",
"referralcode": "sure1zh",
"isExistingUser": false,
"hasReferrer": false,
"success": true,
"statuscode": 1,
"message": "Success"
}
| Output Params | Description |
|---|---|
| success | returns true on successful update |
| message | Information regarding API call (if relevant) |
| userkey | unique identifier for every App User recorded |
| shareurl | referral link of the user |
| referralcode | Referral code of the user |
| isExistingUser | returns true if user is an existing user else it shows false |
| hasReferrer | returns true if user has a referrer else it shows false |