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.

Create a single use access URL

Create a single use URL for a campaign.
You can already preload data from the consumer to this URL. (first name, last name, email, phone)
You can also add your own custom ID to tag the user or add a custom validation code (can be used to display a predefined barcode value)
Base URL
POST: https://api4coupons.com/v3/singleuse/create
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 campaign The unique ID from the campaign Can be found in the list of all campaigns.
Required
4 firstname Add the first name to this single use URL.
Optional
5 lastname Add the first name to this single use URL.
Optional
6 email Add the email address to this single use URL.
Optional
7 phone Adds the phone number to this single use URL.
Optional
8 customid Adds a custom ID to this single use URL. Max 50 characters (az-AZ-09)
Optional
9 customfield1 through customfield7 Adds data to this single use URL. Max 50 characters
Optional
10 customvalcode Adds a custom validation code for this single use URL. Max 100 characters (az-AZ-09).
Cannot be combined with 'autovalcode'.
Optional
11 autovalcode Generates automatically a unique validation code. Available parameters: 6digits, 8digits, 10digits.
Cannot be combined with 'customvalcode'.
Optional
12 duplicate_check False
email
phone
customid
Defaults to false.
If enabled, we will verify if the same user input already received a single use url for that campaign based on the selected field (email or phone or customid), and give back the found session as result instead of new session.
Optional
13 utm_campaign
utm_source
utm_medium
utm_term
utm_content
Google Analytics tags Will appear in exported statistics.
Optional
<?php
	$ch = curl_init();
	$url = "https://api4coupons.com/v3/singleuse/create";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'campaign' => "cam_123456"
	];
	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"
			},
			"campaign": "cam_12345",
			"action": "single_use_code_created",
			"single_use_code": "c43403t2fv7qz27in745p",
			"single_use_url": "https://digicpn.com/p/abc123/c43403t2fv7qz27in745p",
			"widget_validation_code": "c43403",
			"custom_validation_code": "102030405060708",
			"duplicate_found": true (only returned when checking for duplicates)
		}
		
Possible errors
  • 200: Missing parameter: directory
  • 301: Invalid character in parameter: directory.
  • 507: Directory ID not found.

  • Regístrate ahora para una cuenta de prueba por 7 días

    ¡Empieza a usar Coupontools hoy!

¡Genial, estás aquí! ¿Cookies? Lee nuestrasPolíticas de Privacidad. Yo acepto
x