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 a list of your campaigns

Returns a list of all your campaigns.
Base URL
POST: https://api4coupons.com/v3/coupon/list
Parameters
#ParameterInputDescription
1client_idAPI client IDCan be found with your API documentation.
2client_secretAPI client secretCan be found with your API documentation.
3only_activetrue/falseOptional. When set to true, only campaigns marked as 'active' will be returned.
4show_deletedtrue/falseOptional. Default does not show deleted coupons (deleted coupons are permanently deleted once a week).
5sortingasc/descOptional. Default is sorted by createdate ascending.
6categoryThe coupon_category numberOptional. If given, the api will only return coupons of that category
7countryThe company_country of a locationOptional. If given, the api will only return coupons and locations in the specified country
8directorydirectory ID or codeOptional. If given, the api will only return coupons associated with the specified directory
Example response
{
	"status": {
		"status": "OK"
	},

	"amount_of_results": "1",
	"coupon_info": [
		{
			"ID": "cam_123456",
			"code": "tn91r7",
			"url": "https://digicpn.com/p/tn91r7",
			"status": "active", (example | active | archived | template | deleted)
			"subaccount": "sub_12345",
			"timezone": "America/New_York",
			"expirydate": "2018-01-01 04:59:00", (UTC)
			"name": "API EXAMPLE CAMPAIGN",
			"title": "Coupon title",
			"subtitle": "Coupon subtitle",
			"description": "Coupon description content goes here",
			"terms": "Coupon full terms and conditions goes here",
			"terms_short": "Coupon short terms and conditions goes here",
			"poweredby": "MyName",
			"poweredbylink": "http://www.mywebsite.com",
			"coupon_tags": "Coupon,tags,here",
			"coupon_category": "1",
			"coupon_category_name": "Other",
			"logo_url": "http://hosting4images.com/logohere.png",
			"coupon_image": "https://hosting4images.com/upload/basic_couponphoto.jpg",
			"banner1": "https://www.hosting4images.com/preview/tn91r7_120-600.jpg",
			"banner2": "https://www.hosting4images.com/preview/tn91r7_140-112_20170729113501.jpg",
			"banner3": "https://www.hosting4images.com/preview/tn91r7_180-270_20170729113501.jpg",
			"banner4": "https://www.hosting4images.com/preview/tn91r7_200-150.jpg",
			"banner5": "https://www.hosting4images.com/preview/tn91r7_200-600.jpg",
			"locations": [
				{
					"ID": "loc_12345",
					"company_name": "Redeem location 1",
					"company_email": "[email protected]",
					"company_phone": "+1234567890",
					"company_password": "328644",
					"company_street": "Street",
					"company_zip": "Zip",
					"company_city": "City",
					"company_state": "State",
					"company_country": "Country",
					"company_lat": "38.716574",
					"company_long": "-90.307032",
					"company_hours": "9AM - 22PM"
				},
				{
					"ID": "loc_7890"
					"company_name": "Redeem location 2"
					"company_email": "[email protected]"
					"company_phone": "+1234567890"
					"company_password": "302230"
					"company_street": "Another Street"
					"company_zip": "Zip"
					"company_city": "Another City"
					"company_state": "State"
					"company_country": "Country"
					"company_lat": "41.162125"
					"company_long": "-81.544573"
					"company_hours": "10AM-23PM"
				}
			],
			(following three are only shown when the campaign is configured to generate codes)
			"code_prefix": "pf_",
			"code_length": "20",
			"code_type": "alphanumeric"
		}
	]
}

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!