Skip to main content
POST
/
brands
/
api
/
v1
/
brands
Create brand
curl --request POST \
  --url https://www.closient.com/brands/api/v1/brands \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "organization_id": "<string>",
  "name": "<string>",
  "metadata": {},
  "website": "",
  "description": ""
}
'
{
  "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>"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
organization_id
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
​
metadata
Metadata · object

Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.

​
website
string
default:""
​
description
string
default:""

Response

Created

​
id
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

Brand display name.

​
has_social_links
boolean
required

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
​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
website
string
default:""

Brand website URL.

​
description
string
default:""

Brand description.

​
logo_url
string | null

URL of the brand logo image.