Upload a brand asset

curl --request POST \
  --url https://www.closient.com/brands/api/v1/brands/{id}/assets \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file=@example-file \
  --form asset_type=other \
  --form title= \
  --form description= \
  --form is_primary=false

import requests

url = "https://www.closient.com/brands/api/v1/brands/{id}/assets"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "asset_type": "other",
    "title": "",
    "description": "",
    "is_primary": "false"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('asset_type', 'other');
form.append('title', '');
form.append('description', '');
form.append('is_primary', 'false');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://www.closient.com/brands/api/v1/brands/{id}/assets', 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}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "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}/assets"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	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}/assets")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/brands/api/v1/brands/{id}/assets")

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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--"

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

{
  "asset_type": "banner",
  "created": "2026-06-01T09:00:00Z",
  "description": "Homepage hero for the summer range.",
  "height": 400,
  "id": "kL2mN4pQ6rS8tV3wX5yZ7a",
  "is_primary": true,
  "modified": "2026-06-19T14:30:00Z",
  "title": "Summer banner",
  "url": "https://media.closient.com/brands/assets/summer-banner.png",
  "width": 1600
}

{
  "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": "unrecognized image bytes from uploaded file",
  "reason": "invalid_content_type"
}

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

Upload a brand asset

Add a file to the brand’s media library, as a multipart/form-data upload with the file in the file part and the details as form fields. A logo, banner or icon must be an image Closient accepts, read from the file’s own bytes and never its name or declared type: JPEG, PNG, GIF, WebP or BMP, at most 20 MB and 8000 px on either side. Anything else is refused with 422 and a machine-readable reason, and nothing is stored. A document or other asset may be any file. Marking it primary demotes the current primary of its type. 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

brands

{id}

assets

Upload a brand asset

curl --request POST \
  --url https://www.closient.com/brands/api/v1/brands/{id}/assets \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file=@example-file \
  --form asset_type=other \
  --form title= \
  --form description= \
  --form is_primary=false

import requests

url = "https://www.closient.com/brands/api/v1/brands/{id}/assets"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "asset_type": "other",
    "title": "",
    "description": "",
    "is_primary": "false"
}
headers = {"X-API-Key": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('asset_type', 'other');
form.append('title', '');
form.append('description', '');
form.append('is_primary', 'false');

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

options.body = form;

fetch('https://www.closient.com/brands/api/v1/brands/{id}/assets', 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}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "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}/assets"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")

	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}/assets")
  .header("X-API-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.closient.com/brands/api/v1/brands/{id}/assets")

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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"asset_type\"\r\n\r\nother\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"is_primary\"\r\n\r\nfalse\r\n-----011000010111000001101001--"

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

{
  "asset_type": "banner",
  "created": "2026-06-01T09:00:00Z",
  "description": "Homepage hero for the summer range.",
  "height": 400,
  "id": "kL2mN4pQ6rS8tV3wX5yZ7a",
  "is_primary": true,
  "modified": "2026-06-19T14:30:00Z",
  "title": "Summer banner",
  "url": "https://media.closient.com/brands/assets/summer-banner.png",
  "width": 1600
}

{
  "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": "unrecognized image bytes from uploaded file",
  "reason": "invalid_content_type"
}

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

string<shortuuid>

required

URL-safe brand identifier.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

multipart/form-data

file

required

The file to upload.

asset_type

enum<string>

default:other

Kind of asset: logo, banner, icon, document or other.

Available options:

logo,

banner,

icon,

document,

other

title

string

default:""

Optional title, up to 255 characters.

Maximum string length: 255

Pattern: ^[^\x00]{0,255}$

description

string

default:""

Optional description.

Maximum string length: 5000

Pattern: ^[^\x00]{0,}$

is_primary

boolean

default:false

Make this the brand's primary asset of its type, demoting the current one.

Response

Created

One file in a brand's media library.

string<shortuuid>

required

Identifier of the asset.

Required string length: 22

Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

asset_type

enum<string>

required

Kind of asset: logo, banner, icon, document or other.

Available options:

logo,

banner,

icon,

document,

other

title

string

required

Optional title; empty when none was given.

description

string

required

Optional description; empty when none was given.

is_primary

boolean

required

Whether this is the brand's primary asset of its type. Each type has at most one.

url

string

required

URL the file can be downloaded from.

width

integer | null

required

Width in pixels of a logo, banner or icon; null for other types.

height

integer | null

required

Height in pixels of a logo, banner or icon; null for other types.

created

string<date-time>

required

ISO-8601 upload timestamp.

modified

string<date-time>

required

ISO-8601 last-modified timestamp.

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

Upload a brand asset

Authorizations

Path Parameters

Body

Response