Developers can connect our platform with apps or web projects. The Coupontools REST API allows you to query meta-data about your account, campaigns, validations, usage data, distribution of coupons by email or SMS.

REST API Documentation

Retrieve all data from a campaign

Returns a list of all sessions from a campaign.
Base URL
POST: https://api4coupons.com/v3/campaign/data
Base URL for only claims & validations
POST: https://api4coupons.com/v3/campaign/claims
Base URL for only validations
POST: https://api4coupons.com/v3/campaign/validations
Parameters
#ParameterInputDescription
1client_idAPI client IDCan be found with your API documentation.
2client_secretAPI client secretCan be found with your API documentation.
3campaignID from the campaignCan be found in the list of all campaigns.
4pageID from the pageOptional. Default=1. If there are 5000 or more records these will be split in multiple pages.
Example response
{
	"status": {
		"status": "OK"
	},

	"campaign": "cam_12345",
	"action": "retrieve_all_data",
	"data": [
		{
			"session": "kkfiznr8gp8630h82es8d",
			"sequenceid": "19878460",
			"status": {
				"created_date_utc": "2019-03-25 10:43:50",
				"opened": "0",
				"open_date_utc": "",
				"played": "0",
				"played_date_utc": "",
				"claimed": "1",
				"claim_date_utc": "2019-03-25 10:44:05",
				"claimtype": "",
				"saved_to_passbook": "0",
				"saved_to_passbook_date_utc": "",
				"saved_to_androidpay": "0",
				"saved_to_androidpay_date_utc": "",
				"validated": "0",
				"validation_date_utc": "",
				"own_validation_code": "ding_COdHepKvqNrNC8OU",
				"validation_value": "",
				"redeem_location_ID": "",
				"voided": "0",
				"unvoided_date_utc": "2019-03-25 10:44:05",
				"locked": "0",
				"unlocked_date_utc": "",
				"value": "",
				"customid": "",
				"expiration_date": "2019-03-02 02:00:00"
			},
			"user": {
				"gender": "Male",
				"first_name": "John",
				"last_name": "Johnson",
				"address": "Wallstreet 1",
				"zip": "10000",
				"city": "New York",
				"birthday": "1970-01-01",
				"email": "[email protected]",
				"phone": "1234567890",
				"custom1": "A",
				"custom2": "B",
				"custom3": "C",
				"custom4": "D",
				"custom5": "E",
				"custom6": "F",
				"custom7": "G",
				"device": "Windows",
				"profile_picture" => ""
			},
			"campaign": {
				"ID": "cam_1010951",
				"code": "v6n7gn",
				"url": "https://dev.digicpn.com/p/v6n7gn",
				"status": "test",
				"coupon_tags": ""
			}
		]
	}
}

Zapier integration

Zapier Not a developer? Automatically connect Coupontools with your teams' favorite apps like Mailchimp, Constant Contact, Zendesk, SalesForce, and many more - all without writing any code. Zapier connects Coupontools with different apps so you can automate a workflow between them.
For example: You can have the captured email address and name automatically added to a subscribers list in Mailchimp.
Read more about our Zapier integration

Get notifications for events in your account.

Use webhooks to be notified about events that happen in a Coupontools account. Webhooks are a system of automated notifications indicating that an event has occurred in your account. Rather than requiring you to pull information via our API, webhooks push information to your destination when important events occur.

Notifications are delivered via HTTP POST to a destination endpoint on your server and are sent based on the triggers you choose. Each webhook contains a notification kind and the full Coupontools object that the notification is reporting on. This information can be used to update your system or to trigger business processes.

Register now for a 7-days free trial account

Start using Coupontools today!