Coupontools Logo

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.

Single sign on

Generates a single sign on token for a subaccount.
Base URL
# Parameter Input Description
1 client_id API client ID Can be found in your API documentation
2 client_secret API client secret Can be found in your API documentation
3 subaccount ID of the subaccount Numeric only. Can be found in the list of your subaccounts.
4 page page to load after login Available options: campaigns, add_campaign, update_campaign, statistics, distribution.
5 campaign ID of the campaign Only required when you use the page=update_campaign option.
	$ch = curl_init();
	$url = "";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'subaccount' => "sub_1234"
	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 success response
			"status": {
				"status": "OK"
			"subaccount": {
				"ID": "sub_12345",
				"token": "Nu5oAs7QDdCPLN7mkFUAQzPp66JJ8wwDCUd312GeFvZrDlLhf",
				"url": "",
				"url_whitelabel": ""
Example error response
			"status": {
				"status": "failed",
				"errors": {
					"error_message": "HTTP/1.0 422 Unprocessable entity.",
					"error_message_description": [
						"Invalid character in parameter: subaccount."
					"error_code": [
Possible errors
  • 200: Missing parameter: subaccount
  • 510: Subaccount ID not correct.

  • Register now for a 7-days trial account

    Start using Coupontools today!

Great you're here! Cookies? Read our Privacy Policy. I accept