Skip to main content
POST
Create a brand

Authorizations

Authorization
string
header
required

Send your workspace API key as Authorization: Bearer zr_live_….

Body

application/json
name
string
required

The brand's main name.

Required string length: 1 - 255
trackedNames
string[]
Maximum array length: 50
Required string length: 1 - 255
nameRegex
string
Maximum string length: 500
useRegex
boolean
domains
string[]
Maximum array length: 20
Required string length: 1 - 255
status
enum<string>
Available options:
active,
hidden
color
string

A hex color like #FF4D00.

Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Response

The brand was created.

success
boolean
Example:

true

data
object
message
string
Example:

"Brand created successfully"