Skip to main content
PATCH
Update brand

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<shortuuid>
required

URL-safe brand identifier.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json
metadata
Metadata · object | null

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

name
string | null
website
string | null

Brand website. Must start with http:// or https://; any other scheme (javascript:, data:, ftp:, ...) is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
description
string | null
instagram
string | null

Instagram profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
facebook
string | null

Facebook profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
twitter
string | null

X (Twitter) profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
linkedin
string | null

LinkedIn profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
youtube
string | null

YouTube profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
tiktok
string | null

TikTok profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
pinterest
string | null

Pinterest profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$
threads
string | null

Threads profile URL. Must start with http:// or https://; any other scheme is refused with a 422. Send an empty string or null to clear it.

Maximum string length: 255
Pattern: ^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,246})?$

Response

OK

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.

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.

organization_id
string<shortuuid> | null

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}$
website
string
default:""

Brand website URL.

description
string
default:""

Brand description.

logo_url
string | null

URL of the brand logo image.