Skip to main content
PUT
Update a brand

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

The numeric id of the item.

Body

application/json

Send only the fields you want to change.

name
string
Required string length: 1 - 255
trackedNames
string[] | null
Maximum array length: 50
Required string length: 1 - 255
nameRegex
string | null
Maximum string length: 500
useRegex
boolean
domains
string[] | null
Maximum array length: 20
Required string length: 1 - 255
status
enum<string>
Available options:
active,
hidden
type
enum<string>
Available options:
own,
competitor
color
string | null
Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

Response

A brand.

success
boolean
Example:

true

data
object
message
string
Example:

"Brand retrieved successfully"