PATCH
Update Brand Group

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

group_id
integer
required

A brand group of the brand.

brand_id
integer
required

Body

application/json

Only the fields that the request sends change.

brand_rank
integer | null
Required range: 1 <= x <= 1000
description
string | null
Maximum string length: 2000
include_brand
boolean | null
name
string | null
Required string length: 1 - 255

Response

Successful Response

brand_rank
integer
required

The rank of the brand in the group.

created_at
string<date-time>
required
id
integer
required
include_brand
boolean
required

The brand is a member of the group.

members
PublicGroupMember · object[]
required

The competitors of the group, rank 1 first.

name
string
required
updated_at
string<date-time>
required
description
string | null