Create link-type coupon
curl --request POST \
--url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gcn": "9501101530003",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_until": "2026-12-31T23:59:00Z"
}
'import requests
url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons"
payload = {
"gcn": "9501101530003",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_until": "2026-12-31T23:59:00Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
gcn: '9501101530003',
redemption_url: 'https://acmesnacks.com/coupons/2off',
terms: 'One per customer.',
title: 'Two dollars off',
valid_until: '2026-12-31T23:59:00Z'
})
};
fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'gcn' => '9501101530003',
'redemption_url' => 'https://acmesnacks.com/coupons/2off',
'terms' => 'One per customer.',
'title' => 'Two dollars off',
'valid_until' => '2026-12-31T23:59:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons"
payload := strings.NewReader("{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2026-06-01T09:00:00Z",
"gcn": "9501101530003",
"id": "a1b2c3d4e5f6",
"modified": "2026-06-19T14:30:00Z",
"organization_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_from": "2026-06-01T00:00:00Z",
"valid_until": "2026-12-31T23:59:00Z"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Link-type sections
Create link-type coupon
Create a GCN-resolved coupon for the organization. This is a GS1 coupon, not a Stripe coupon. The GCN must be a well-formed GS1 key (digits only) and unique across Closient (409 if another row holds it, 422 if malformed). Requires CONTRIBUTE: a read-only key gets 403.
POST
/
resolver
/
api
/
v1
/
organizations
/
{organization_id}
/
link-type-coupons
Create link-type coupon
curl --request POST \
--url https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"gcn": "9501101530003",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_until": "2026-12-31T23:59:00Z"
}
'import requests
url = "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons"
payload = {
"gcn": "9501101530003",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_until": "2026-12-31T23:59:00Z"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
gcn: '9501101530003',
redemption_url: 'https://acmesnacks.com/coupons/2off',
terms: 'One per customer.',
title: 'Two dollars off',
valid_until: '2026-12-31T23:59:00Z'
})
};
fetch('https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'gcn' => '9501101530003',
'redemption_url' => 'https://acmesnacks.com/coupons/2off',
'terms' => 'One per customer.',
'title' => 'Two dollars off',
'valid_until' => '2026-12-31T23:59:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons"
payload := strings.NewReader("{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/resolver/api/v1/organizations/{organization_id}/link-type-coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gcn\": \"9501101530003\",\n \"redemption_url\": \"https://acmesnacks.com/coupons/2off\",\n \"terms\": \"One per customer.\",\n \"title\": \"Two dollars off\",\n \"valid_until\": \"2026-12-31T23:59:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"created": "2026-06-01T09:00:00Z",
"gcn": "9501101530003",
"id": "a1b2c3d4e5f6",
"modified": "2026-06-19T14:30:00Z",
"organization_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"redemption_url": "https://acmesnacks.com/coupons/2off",
"terms": "One per customer.",
"title": "Two dollars off",
"valid_from": "2026-06-01T00:00:00Z",
"valid_until": "2026-12-31T23:59:00Z"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Authorizations
APIKeyHeaderAuthOAuthTokenAuthCookieGatedSessionAuth
Path Parameters
UUID of the organization that owns the records.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
application/json
Payload to create a GCN coupon.
Global Coupon Number (AI 255), 13 to 25 digits. Unique across Closient.
Maximum string length:
25Pattern:
^[^\x00]{0,25}$Display title of the coupon (max 255 characters).
Maximum string length:
255Pattern:
^[^\x00]{0,255}$The coupon's terms.
Pattern:
^[^\x00]{0,}$Where a shopper redeems the coupon: an absolute http(s) URL of at most 2048 characters.
Maximum string length:
2048Pattern:
^[Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,2039}$When the coupon becomes valid (ISO-8601).
When the coupon stops being valid (ISO-8601).
Response
Created
A GCN coupon as read from the API.
URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Global Coupon Number (AI 255), 13 to 25 digits. Unique across Closient.
Display title of the coupon (max 255 characters).
The coupon's terms; empty when none were given.
UUID of the organization that owns the coupon.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ISO-8601 creation timestamp.
ISO-8601 last-modified timestamp.
Where a shopper redeems the coupon.
When the coupon becomes valid, or null.
When the coupon stops being valid, or null.