Get coupon Pools
This API will allow you get the details of coupon pools which were added in the reward configuration and coupon distribution type “user will choose“.
Base URL https://api.appvirality.com
POST /v2_0/GetCouponPools
Content-Type application/json
Input i.e. Request
{ "apikey":"7b808b1f969048db8463a4c60091c49b", "privatekey":"09726325ed71465191eda4ec006d601b", "userkey": "", "EmailId":"surya12@gmail.com", "UserIdInstore":"", "campaignid": "283" }
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 an 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 |
campaignid (optional) |
Unique ID of a campaign, generated by AppVirality |
conditional – One of the conditional parameters is mandatory to identify the user. Priority for user identification is userkey, UserIdInstore and EmailId
Response
Provide Emailid or Userkey or Userstoreid in the request, you will see the coupon pool details associated with the user.
If you give all the three parameters then the priority is in the respective order Userkey, Userstoreid and Emailid.The response is as below:
{ "campaigns": [ { "campaignId": "283", "campaignName": "mom test v1 m", "growthhack": "Word_of_Mouth", "pools": [ { "poolId": "289", "name": "test pool", "details": "nbmxn", "image": "", "value": "10" }, { "poolId": "290", "name": "upload test", "details": "pool description displaying or not description", "image": "", "value": "10" }, { "poolId": "291", "name": "surya", "details": "sam,dnmkn", "image": "", "value": "10" }, { "poolId": "295", "name": "tum1", "details": "klklk", "image": "", "value": "78" } ] } ], "success": true, "statuscode": 1, // code based on status of the API call "message": success // Information regarding API call (if relevant) }
If you give incorrect input parameters then the response will be false.
Status codes which you will see while using Get coupon Pools API
Status Code | Description |
---|---|
0 | No data found for the search criteria |
1 | Success |
2 | Invalid User Key |
5 | Invalid StoreID or EmailID |