HomeSaaS Referral Program GuideAPIsInvokeoutreach


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

 POST         /saas/v1_0/invokeoutreach

Content-Type application/json

Input i.e. Request

"userkey": "176502556c624614b913a62400ab4d7e",
"ProfileImage":"[Image URL]",
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
ID of the user in your App (helps to identify users on dashboard as you do in your app)
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.
User profile picture URL (required to personalize the referral messages)
City of the User Location
State of the User Location
Country of the User Location
User phone number (Digits only)


    "userkey": "176502556c624614b913a62400ab4d7e",
    "shareurl": "",
    "referralcode": "sure1zh",
    "isExistingUser": false,
    "hasReferrer": false,
    "success": true,
    "statuscode": 1,
    "message": "Success"
Response Params
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
Was this article helpful to you? Yes No