Create a brand video page
curl --request POST \
--url https://www.closient.com/brands/api/v1/brands/{id}/video-pages \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"accent_color": "#ff9500",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"name": "Spring launch video",
"primary_color": "#0a84ff",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
'import requests
url = "https://www.closient.com/brands/api/v1/brands/{id}/video-pages"
payload = {
"accent_color": "#ff9500",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"name": "Spring launch video",
"primary_color": "#0a84ff",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
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({
accent_color: '#ff9500',
cta_links: [{label: 'Buy now', url: 'https://brand.example/shop'}],
name: 'Spring launch video',
primary_color: '#0a84ff',
youtube_url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
})
};
fetch('https://www.closient.com/brands/api/v1/brands/{id}/video-pages', 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/brands/api/v1/brands/{id}/video-pages",
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([
'accent_color' => '#ff9500',
'cta_links' => [
[
'label' => 'Buy now',
'url' => 'https://brand.example/shop'
]
],
'name' => 'Spring launch video',
'primary_color' => '#0a84ff',
'youtube_url' => 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
]),
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/brands/api/v1/brands/{id}/video-pages"
payload := strings.NewReader("{\n \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\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/brands/api/v1/brands/{id}/video-pages")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/brands/api/v1/brands/{id}/video-pages")
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 \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}"
response = http.request(request)
puts response.read_body{
"accent_color": "#ff9500",
"brand_name_override": "",
"created": "2026-06-01T09:00:00Z",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"description": "See how the spring range is made.",
"id": "vR3sT5uW7xY9zA2bC4dE6f",
"modified": "2026-06-19T14:30:00Z",
"name": "Spring launch video",
"primary_color": "#0a84ff",
"tagline": "Made by hand in Portland",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}{
"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"
}Brand video pages
Create a brand video page
Create a video page a resolver rule can then send scans to. Requires the Owner, Manager or Editor role on the organization that owns the brand; a read-only key is refused with 403.
POST
/
brands
/
api
/
v1
/
brands
/
{id}
/
video-pages
Create a brand video page
curl --request POST \
--url https://www.closient.com/brands/api/v1/brands/{id}/video-pages \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"accent_color": "#ff9500",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"name": "Spring launch video",
"primary_color": "#0a84ff",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
'import requests
url = "https://www.closient.com/brands/api/v1/brands/{id}/video-pages"
payload = {
"accent_color": "#ff9500",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"name": "Spring launch video",
"primary_color": "#0a84ff",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}
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({
accent_color: '#ff9500',
cta_links: [{label: 'Buy now', url: 'https://brand.example/shop'}],
name: 'Spring launch video',
primary_color: '#0a84ff',
youtube_url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
})
};
fetch('https://www.closient.com/brands/api/v1/brands/{id}/video-pages', 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/brands/api/v1/brands/{id}/video-pages",
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([
'accent_color' => '#ff9500',
'cta_links' => [
[
'label' => 'Buy now',
'url' => 'https://brand.example/shop'
]
],
'name' => 'Spring launch video',
'primary_color' => '#0a84ff',
'youtube_url' => 'https://www.youtube.com/watch?v=dQw4w9WgXcQ'
]),
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/brands/api/v1/brands/{id}/video-pages"
payload := strings.NewReader("{\n \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\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/brands/api/v1/brands/{id}/video-pages")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/brands/api/v1/brands/{id}/video-pages")
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 \"accent_color\": \"#ff9500\",\n \"cta_links\": [\n {\n \"label\": \"Buy now\",\n \"url\": \"https://brand.example/shop\"\n }\n ],\n \"name\": \"Spring launch video\",\n \"primary_color\": \"#0a84ff\",\n \"youtube_url\": \"https://www.youtube.com/watch?v=dQw4w9WgXcQ\"\n}"
response = http.request(request)
puts response.read_body{
"accent_color": "#ff9500",
"brand_name_override": "",
"created": "2026-06-01T09:00:00Z",
"cta_links": [
{
"label": "Buy now",
"url": "https://brand.example/shop"
}
],
"description": "See how the spring range is made.",
"id": "vR3sT5uW7xY9zA2bC4dE6f",
"modified": "2026-06-19T14:30:00Z",
"name": "Spring launch video",
"primary_color": "#0a84ff",
"tagline": "Made by hand in Portland",
"youtube_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
}{
"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
URL-safe brand identifier.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
application/json
Payload to create a video page.
Internal label shown to brand managers when picking a page for a rule, 1 to 120 characters. Unique among the brand's pages of this kind; a name already in use is refused with 422.
Required string length:
1 - 120Pattern:
^[^\x00]{1,120}$Header background colour, a 6-digit hex value such as #0a84ff.
Pattern:
^#[0-9A-Fa-f]{6}$Button and link colour, a 6-digit hex value such as #ff9500.
Pattern:
^#[0-9A-Fa-f]{6}$Header brand name to show instead of the brand's own, up to 120 characters.
Maximum string length:
120Pattern:
^[^\x00]{0,120}$One-line tagline under the brand name, up to 160 characters.
Maximum string length:
160Pattern:
^[^\x00]{0,160}$YouTube video URL, up to 512 characters. Leave empty to show the first video attached to the product being resolved.
Maximum string length:
512Pattern:
^[^\x00]{0,512}$Brand-level text shown below the video, up to 500 characters.
Maximum string length:
500Pattern:
^[^\x00]{0,500}$Up to three call-to-action buttons, in order.
Maximum array length:
3Show child attributes
Show child attributes
Response
Created
A brand-styled landing page built around a YouTube video.
Identifier of the page.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Internal label shown to brand managers when picking a page for a rule.
Header brand name shown instead of the brand's own; empty to use the brand's name.
One-line tagline under the brand name; empty when none.
Header background colour, a 6-digit hex value such as #0a84ff.
Button and link colour, a 6-digit hex value such as #ff9500.
ISO-8601 creation timestamp.
ISO-8601 last-modified timestamp.
YouTube video shown on the page; empty to show the first video attached to the product being resolved.
Brand-level text shown below the video; empty when none.
Up to three call-to-action buttons, in order.
Show child attributes
Show child attributes