Skip to main content
PATCH
/
brands
/
api
/
v1
/
brands
/
{public_id}
Update brand
curl --request PATCH \
  --url https://www.closient.com/brands/api/v1/brands/{public_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "website": "<string>",
  "description": "<string>",
  "instagram": "<string>",
  "facebook": "<string>",
  "twitter": "<string>",
  "linkedin": "<string>",
  "youtube": "<string>",
  "tiktok": "<string>",
  "pinterest": "<string>",
  "threads": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "public_id": "<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>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "website": "",
  "description": "",
  "logo_url": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

public_id
string
required

URL-safe brand identifier.

Body

application/json
name
string | null
website
string | null
description
string | null
instagram
string | null
facebook
string | null
twitter
string | null
linkedin
string | null
youtube
string | null
tiktok
string | null
pinterest
string | null
threads
string | null

Response

OK

id
integer
required

Unique brand identifier.

name
string
required

Brand display name.

public_id
string
required

URL-safe brand identifier.

Whether the brand has any social media links.

created
string<date-time>
required

When the brand was created.

instagram
string
required
facebook
string
required
twitter
string
required
linkedin
string
required
youtube
string
required
tiktok
string
required
pinterest
string
required
threads
string
required
organization_id
string<uuid>
required
website
string
default:""

Brand website URL.

description
string
default:""

Brand description.

logo_url
string | null

URL of the brand logo image.