Skip to content

/v1/brands/{id} (PATCH)

PATCH
/v1/brands/{id}
curl --request PATCH \
--url https://example.com/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "city": "example", "street": "example", "zipcode": "example", "country_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locale": "example", "email": "example", "phone": "example", "managing_director_under_commercial_law": "example", "vat": "example", "company_registration_number": "example", "producer_identification_number": "example", "organic_certification_number": "example", "commercial_court": "example", "logo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "default_bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "default_distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "website": "example", "webshop": "example", "imprint": "example", "imprint_href": "example", "privacy_href": "example", "facebook": "example", "instagram": "example", "youtube": "example", "tiktok": "example", "linkedin": "example", "label_bg_hero_color": "example", "is_primary_brand": true }'

Update a brand. Only the listed fields are writable; omitted keys are untouched, explicit null clears a nullable field. Email, phone and managing director are the brand’s business contact data and are writable.

id
required
string format: uuid
Media typeapplication/json
object
name
string
>= 1 characters <= 2000 characters
city
string | null
<= 2000 characters
street
string | null
<= 2000 characters
zipcode
string | null
<= 2000 characters
country_id
string | null format: uuid
locale
string | null
<= 2000 characters
email
string | null
<= 2000 characters
phone
string | null
<= 2000 characters
managing_director_under_commercial_law
string | null
<= 2000 characters
vat
string | null
<= 2000 characters
company_registration_number
string | null
<= 2000 characters
producer_identification_number
string | null
<= 2000 characters
organic_certification_number
string | null
<= 2000 characters
commercial_court
string | null
<= 2000 characters
logo_id
string | null format: uuid
primary_brand_asset_id
string | null format: uuid
default_bottler_id
string | null format: uuid
default_distributor_id
string | null format: uuid
ppwr_importer_id
string | null format: uuid
ppwr_manufacturer_id
string | null format: uuid
website
string | null
<= 2000 characters
webshop
string | null
<= 2000 characters
imprint
string | null
<= 2000 characters
imprint_href
string | null
<= 2000 characters
privacy_href
string | null
<= 2000 characters
facebook
string | null
<= 2000 characters
instagram
string | null
<= 2000 characters
youtube
string | null
<= 2000 characters
tiktok
string | null
<= 2000 characters
linkedin
string | null
<= 2000 characters
label_bg_hero_color
string | null
<= 2000 characters
is_primary_brand
boolean
Examplegenerated
{
"name": "example",
"city": "example",
"street": "example",
"zipcode": "example",
"country_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"locale": "example",
"email": "example",
"phone": "example",
"managing_director_under_commercial_law": "example",
"vat": "example",
"company_registration_number": "example",
"producer_identification_number": "example",
"organic_certification_number": "example",
"commercial_court": "example",
"logo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"default_bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"default_distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"website": "example",
"webshop": "example",
"imprint": "example",
"imprint_href": "example",
"privacy_href": "example",
"facebook": "example",
"instagram": "example",
"youtube": "example",
"tiktok": "example",
"linkedin": "example",
"label_bg_hero_color": "example",
"is_primary_brand": true
}

The updated brand

Media typeapplication/json
object
id
required
string format: uuid
workspace_id
required
string format: uuid
name
required
string
<= 2000 characters
slug
required
string | null
<= 2000 characters
is_primary_brand
required
boolean
is_published
required
boolean
short_url
required
string | null
<= 2000 characters
locale
required
string | null
<= 2000 characters
country_id
required
string | null format: uuid
city
required
string | null
<= 2000 characters
street
required
string | null
<= 2000 characters
zipcode
required
string | null
<= 2000 characters
email
required
string | null
<= 2000 characters
phone
required
string | null
<= 2000 characters
managing_director_under_commercial_law
required
string | null
<= 2000 characters
vat
required
string | null
<= 2000 characters
company_registration_number
required
string | null
<= 2000 characters
producer_identification_number
required
string | null
<= 2000 characters
organic_certification_number
required
string | null
<= 2000 characters
commercial_court
required
string | null
<= 2000 characters
logo_id
required
string | null format: uuid
primary_brand_asset_id
required
string | null format: uuid
default_bottler_id
required
string | null format: uuid
default_distributor_id
required
string | null format: uuid
ppwr_importer_id
required
string | null format: uuid
ppwr_manufacturer_id
required
string | null format: uuid
website
required
string | null
<= 2000 characters
webshop
required
string | null
<= 2000 characters
imprint
required
string | null
<= 2000 characters
imprint_href
required
string | null
<= 2000 characters
privacy_href
required
string | null
<= 2000 characters
facebook
required
string | null
<= 2000 characters
instagram
required
string | null
<= 2000 characters
youtube
required
string | null
<= 2000 characters
tiktok
required
string | null
<= 2000 characters
linkedin
required
string | null
<= 2000 characters
label_bg_hero_color
required
string | null
<= 2000 characters
Examplegenerated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"slug": "example",
"is_primary_brand": true,
"is_published": true,
"short_url": "example",
"locale": "example",
"country_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"city": "example",
"street": "example",
"zipcode": "example",
"email": "example",
"phone": "example",
"managing_director_under_commercial_law": "example",
"vat": "example",
"company_registration_number": "example",
"producer_identification_number": "example",
"organic_certification_number": "example",
"commercial_court": "example",
"logo_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"primary_brand_asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"default_bottler_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"default_distributor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ppwr_importer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ppwr_manufacturer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"website": "example",
"webshop": "example",
"imprint": "example",
"imprint_href": "example",
"privacy_href": "example",
"facebook": "example",
"instagram": "example",
"youtube": "example",
"tiktok": "example",
"linkedin": "example",
"label_bg_hero_color": "example"
}

Invalid body

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Brand not found or not writable

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
<= 2000 characters
title
required
string
<= 2000 characters
status
required
number
detail
string
<= 2000 characters
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}