Create single use - API's & Webhooks Coupontools

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);
?>

const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const data = JSON.stringify({
	campaign: "cam_123456"
});
const options = {
    hostname: "api4coupons.com",
    port: 443,
    path: "/v3/singleuse/create",
    method: "POST",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
		"Content-Type": "application/json",
		"Content-Length": data.length,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

require "uri"
require "net/http"

url = URI("https://api4coupons.com/v3/singleuse/create")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = "XXX" // Your API client ID (required)
request["X-Client-Secret"] = "YYY" // Your API client secret (required)
request["Content-Type"] = "application/json"
form_data = [
	['campaign', "cam_123456"]
]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

import requests
url = "https://api4coupons.com/v3/singleuse/create"
payload={
	'campaign': 'cam_123456'
}
files=[]
headers = {
	'X-Client-Id': 'XXX', #Your API client ID (required)
	'X-Client-Secret': 'YYY', #Your API client secret (required)
	'Content-Type': 'application/json'
}
response = requests.request(
	"POST",
	url,
	headers=headers,
	data=payload,
	files=files
)
print(response.text)

var url = "https://api4coupons.com/v3/singleuse/create";
var client = new RestClient(url);
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("X-Client-Id", "XXX"); // Your API client ID (required)
request.AddHeader("X-Client-Secret", "YYY"); // Your API client secret (required)
request.AddHeader("Content-Type", "application/json");
request.AlwaysMultipartFormData = true;
request.AddParameter("campaign", "cam_123456");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

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.

API & Webhooks

API

Guides

Account

Subaccount

Campaign

Loyalty Card

Directory

Single Use

Coupontools SMS services

Coupontools Email services

Create a single use access URL

Base URL

Parameters

Example response

Possible errors

Inscrivez-vous pour un compte d'essai de 7 jours

Produits

Par type d'entreprise

Par besoin

Par secteur d'activité

Par approche marketing

API & Webhooks

API

Guides

Account

Subaccount

Campaign

Loyalty Card

Directory

Single Use

Coupontools SMS services

Coupontools Email services

Create a single use access URL

Base URL

Parameters

Example response

Possible errors

Inscrivez-vous pour un compte d'essai de 7 jours