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
Definitions
Campaign
A campaign is the layout/settings for 1 coupon for 1 business. Our platform assigns a unique URL for each campaign.A coupon can have multiple redeem locations.
Example campaign URL: https://digicpn.com/p/vuhykb
Coupon session
Every consumer who opens or received a coupon from the merchant will have a unique URL assigned.Example coupon session URL: https://digicpn.com/p/vuhykb/ac6s7u3g8a25ja7x9qg87
Directory
A method to group multiple campaigns and plugins for mobile apps, websites, touch TVs, Facebook tabs.ID overview
| cam_12345 | Campaign ID | The unique reference for a campaign (active,example,archived & templates) |
| sub_12345 | Subaccount ID | The unique reference to identify a subaccount. |
| loc_12345 | Redeem location ID | The unique reference to identify a redeem location that belongs to a campaign. |
| lloc_12345 | Loyalty card redeem location ID | The unique reference to identify a redeem location that belongs to a loyalty card. |
| dir_12345 | Directory ID | The unique reference to identify a coupon directory. |
| cat_12345 | Category ID | The unique reference to identify a category. |
| loy_12345 | Loyalty Card ID | The unique reference to identify a loyalty card. |
| lus_12345 | Loyalty Card User ID | The unique reference to identify a loyalty card user. |
| reg_12345 | Registered user ID | The unique reference to identify a registered profile to a coupon directory. |
| gro_12345 | Smstools Group ID | The unique reference to identify the SMS group. |
| con_12345 | Smstools Contact ID | The unique reference to identify the SMS contact. |
| evt_12345abcdef12345567890 | Webhook event ID. |