curl --request PATCH \
--url https://www.closient.com/brands/api/v1/brands/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"metadata": {},
"name": "<string>",
"website": "<string>",
"description": "<string>",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>"
}
'import requests
url = "https://www.closient.com/brands/api/v1/brands/{id}"
payload = {
"metadata": {},
"name": "<string>",
"website": "<string>",
"description": "<string>",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>"
}
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({
metadata: {},
name: '<string>',
website: '<string>',
description: '<string>',
instagram: '<string>',
facebook: '<string>',
twitter: '<string>',
linkedin: '<string>',
youtube: '<string>',
tiktok: '<string>',
pinterest: '<string>',
threads: '<string>'
})
};
fetch('https://www.closient.com/brands/api/v1/brands/{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/brands/api/v1/brands/{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([
'metadata' => [
],
'name' => '<string>',
'website' => '<string>',
'description' => '<string>',
'instagram' => '<string>',
'facebook' => '<string>',
'twitter' => '<string>',
'linkedin' => '<string>',
'youtube' => '<string>',
'tiktok' => '<string>',
'pinterest' => '<string>',
'threads' => '<string>'
]),
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}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\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/brands/api/v1/brands/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/brands/api/v1/brands/{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 \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"has_social_links": true,
"created": "2023-11-07T05:31:56Z",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>",
"metadata": {},
"website": "",
"description": "",
"logo_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}Update brand
Update brand profile fields. Requires OWNER or MANAGER role.
curl --request PATCH \
--url https://www.closient.com/brands/api/v1/brands/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"metadata": {},
"name": "<string>",
"website": "<string>",
"description": "<string>",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>"
}
'import requests
url = "https://www.closient.com/brands/api/v1/brands/{id}"
payload = {
"metadata": {},
"name": "<string>",
"website": "<string>",
"description": "<string>",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>"
}
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({
metadata: {},
name: '<string>',
website: '<string>',
description: '<string>',
instagram: '<string>',
facebook: '<string>',
twitter: '<string>',
linkedin: '<string>',
youtube: '<string>',
tiktok: '<string>',
pinterest: '<string>',
threads: '<string>'
})
};
fetch('https://www.closient.com/brands/api/v1/brands/{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/brands/api/v1/brands/{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([
'metadata' => [
],
'name' => '<string>',
'website' => '<string>',
'description' => '<string>',
'instagram' => '<string>',
'facebook' => '<string>',
'twitter' => '<string>',
'linkedin' => '<string>',
'youtube' => '<string>',
'tiktok' => '<string>',
'pinterest' => '<string>',
'threads' => '<string>'
]),
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}"
payload := strings.NewReader("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\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/brands/api/v1/brands/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/brands/api/v1/brands/{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 \"metadata\": {},\n \"name\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"instagram\": \"<string>\",\n \"facebook\": \"<string>\",\n \"twitter\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"youtube\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"pinterest\": \"<string>\",\n \"threads\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"has_social_links": true,
"created": "2023-11-07T05:31:56Z",
"instagram": "<string>",
"facebook": "<string>",
"twitter": "<string>",
"linkedin": "<string>",
"youtube": "<string>",
"tiktok": "<string>",
"pinterest": "<string>",
"threads": "<string>",
"metadata": {},
"website": "",
"description": "",
"logo_url": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"error_code": "<string>",
"timestamp": "<string>",
"retryable": false,
"retry_after": 123,
"owner_action_required": true,
"details": "<unknown>"
}Authorizations
Path Parameters
URL-safe brand identifier.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.
Show child attributes
Show child attributes
Response
OK
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).
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Brand display name.
Whether the brand has any social media links.
When the brand was created.
Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.
Show child attributes
Show child attributes
Brand website URL.
Brand description.
URL of the brand logo image.