API & Webhooks
Connect the Coupontools platform with your apps or web projects. The Coupontools REST API allows you to query meta-data about your account, campaigns, distribution, validations, and usage data.
-
Subaccount
- Retrieve a list of subaccounts
- Retrieve info of a subaccount
- Create a subaccount
- Update a subaccount
- Create password reset url for subaccount
- Single sign on for subaccounts
-
Campaign
- Retrieve a list of your campaigns
- Retrieve information from a campaign
- Retrieve all usage data from a campaign
- Retrieve all data from one coupon session
- Update data from a coupon session
- Update data from multiple coupon sessions
- Search coupon session
- Search coupon session from a campaign
- Send single push notification
- Send push notification to all
-
Loyalty Card
- Retrieve a list of your loyalty cards
- Retrieve a list of users from a loyalty card
- Update loyalty card user
- Send single push notification
- Send push notification to all
-
Directory
- Retrieve a list of your directories
- Retrieve information from a directory
- Retrieve all campaigns from a directory
- Retrieve registered users from a directory
- Update directory user payment status
- Retrieve a list of categories
- Retrieve a list of 3rd level categories
-
Single Use
- Create a single use access URL
- Create multiple single use access URLs
- Remove a single use access URL
Update a loyalty user.
Allows you to update a loyalty card user: add points, add stamps, set user to voided/not voidedBase URL
POST: https://api4coupons.com/v3/loyaltyusers/update
Parameters
| # | Parameter | Input | Description | |
|---|---|---|---|---|
| 1 | client_id | API client ID | Can be found in your API documentation | Required |
| 2 | client_secret | API client secret | Can be found in your API documentation | Required |
| 3 | loyaltycard | ID from the loyaltycard | Can be found in the list of all loyalty cards. |
Required
|
| 4 | user | ID from the loyaltycard user | Can be found in the list of all loyalty cards users or with the search function. |
Required
|
| 5 | action | add_points add_stamps remove_points remove_stamps |
Adds points to the loyalty card of this user Adds stamps to the loyalty card of this user Remove points from the loyalty card of this user Remove stamps from the loyalty card of this user |
Optional
|
| 6 | amount | Amount of stamps or points | Only integers allowed. |
Optional
|
| 7 | merchantid | ID of the merchant (location) | Can be found in the list of all loyalty cards. |
Optional
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/loyaltyusers/update"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'loyaltycard' => "loy_12345", 'user' => "lus_12345" ]; curl_setopt($ch, CURLOPT_URL, "$url"); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_VERBOSE, true); curl_setopt($ch, CURLOPT_HTTPHEADER, [ "X-Client-Id: $client_id", "X-Client-Secret: $client_secret", "Content-Type: application/json", ]); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); $response = curl_exec($ch); ?>
Example response
{
"status": {
"status": "OK"
},
"loyaltycard": {
"ID": "loy_1234567",
"code": "abc123",
"url": "https://loyaltycard.mobi/ac/abc123",
"name": "Your loyalty card",
"type": "stampcard"
},
"user": {
"ID": "lus_12345",
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"profile_picture": "https://graph.facebook.com/picture?type=large",
"email": "john@doe.com",
"phone": ""
},
"action": "add_stamps",
"old_amount": "4",
"added_amount": "1",
"new_amount": "5",
"rewards_added": [
{
"ID": "cam_1010470",
"name": "Coupon name",
"at": 5,
"at_complete": false,
"statcode": "r2p2s1n38nwb1mcz8xd26",
"url": "https://digicpn.com/p/ne7xgs/r2p2s1n38nwb1mcz8xd26"
}
]
}
Possible errors
- 200: Missing parameter: loyaltycard
- 200: Missing parameter: user
- 200: Missing parameter: action
- 301: Not a valid value for field amount
- 301: Invalid character in parameter: loyaltycard.
- 301: Invalid character in parameter: user.
- 306: You cannot add points to a stamp card
- 505: Loyalty card ID not found.
- 506: Loyalty card user ID not found.
- 606 The amount you're trying to add exceeds the daily limit for this merchant and card.