Update retailer client

curl --request PATCH \
  --url https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "is_enabled": false
}
'

import requests

url = "https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}"

payload = { "is_enabled": False }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({is_enabled: false})
};

fetch('https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}', 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/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_enabled' => false
  ]),
  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/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}"

	payload := strings.NewReader("{\n  \"is_enabled\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_enabled\": false\n}"

response = http.request(request)
puts response.read_body

{
  "backfill_lookback_days": 90,
  "client_id": "rc_documentationExampleClientIdNotReal",
  "created": "2026-09-07T21:00:00Z",
  "id": "d5e6f7a8-9012-3456-abcd-ef7890123456",
  "is_enabled": true,
  "name": "Loyalty backend (production)",
  "retailer_id": "a1b2c3d4-5678-9012-abcd-ef1234567890",
  "scope": "write",
  "secret_prefix": "rcs_Ab3",
  "sector_identifier": "shop.example-retailer.com",
  "submission_cadence_hours": 24
}

{
  "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"
}

PATCH

account

api

organizations

{organization_id}

retailer-clients

{client_id}

Update retailer client

curl --request PATCH \
  --url https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "is_enabled": false
}
'

import requests

url = "https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}"

payload = { "is_enabled": False }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({is_enabled: false})
};

fetch('https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}', 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/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_enabled' => false
  ]),
  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/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}"

	payload := strings.NewReader("{\n  \"is_enabled\": false\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/account/api/v1/organizations/{organization_id}/retailer-clients/{client_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_enabled\": false\n}"

response = http.request(request)
puts response.read_body

{
  "backfill_lookback_days": 90,
  "client_id": "rc_documentationExampleClientIdNotReal",
  "created": "2026-09-07T21:00:00Z",
  "id": "d5e6f7a8-9012-3456-abcd-ef7890123456",
  "is_enabled": true,
  "name": "Loyalty backend (production)",
  "retailer_id": "a1b2c3d4-5678-9012-abcd-ef1234567890",
  "scope": "write",
  "secret_prefix": "rcs_Ab3",
  "sector_identifier": "shop.example-retailer.com",
  "submission_cadence_hours": 24
}

{
  "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

X-API-Key

string

header

required

Path Parameters

organization_id

string<shortuuid>

required

Organization ID.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

client_id

string<shortuuid>

required

ID of the retailer client.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

RetailerClientUpdate
RetailerClientUpdate

Request body for enabling or disabling a retailer client, or changing its scope.

is_enabled

boolean

required

False rejects this client's credentials without deleting the client or its links. Re-enabling is refused while a compromise window is open.

scope

enum<string>

What the credentials may do. Takes effect on the client's next request.

Available options:

write,

read

Response

A registered retailer client. Never carries the client secret.

string<shortuuid>

required

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: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

name

string

required

Human-readable label for this credential.

client_id

string

required

Public client identifier. Opaque, stable, safe to log.

sector_identifier

string

required

Canonical (lower-cased) host that scopes the pairwise subject identifiers issued to this client. Belongs to one organization.

submission_cadence_hours

integer

required

How often, in hours, the retailer declares it will submit purchases.

is_enabled

boolean

required

False while the client's credentials are rejected.

scope

enum<string>

required

What the credentials may do. write may redeem enrollment codes; read is read-only.

Available options:

write,

read

secret_prefix

string

required

Leading characters of the current secret, for identification only. Never sufficient to authenticate.

created

string

required

ISO 8601 timestamp the client was registered.

retailer_id

string<shortuuid> | null

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

backfill_lookback_days

integer | null

How many days back the retailer declares it will backfill purchases on first link. Null means the retailer declared it sends no history, so a consumer's coverage begins at the link date.

secret_rotated_at

string | null

ISO 8601 timestamp the secret was last rotated, or null if the original is still current.

last_used

string | null

ISO 8601 timestamp of the last successful authentication, or null if never used.

Overview

Account

Products

Brands

Locations

Retailers

Search

GS1 Digital Link

EPCIS 2.0

Integrations

Billing

Scanner

Compliance

Certifications

Sustainability

Notifications

Dashboard

Analytics

Agent

Substances

BYOS

Content

Signals

Update retailer client

Authorizations

Path Parameters

Body

Response