PATCH
cURL
Restricted. Requires Apple API access. Returns 403 with APPLE_API_DISABLED otherwise.
Requires an Organization token.
Updates a brand. All fields are optional; at least one is required. apple_company_id cannot change. primary_category is required whenever categories change.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

segment_id
string
required

Brand segment id (brand-<uuid>)

Body

application/json

All fields optional; at least one is required. apple_company_id cannot change.

brand_name
string
country_code
string

ISO 3166-1 alpha-2 country code.

Required string length: 2
primary_category
string

Required whenever categories change (stored values are never re-mapped).

additional_categories
string[]
Maximum array length: 19
website_url
string<uri>
app_store_url
string<uri>
ownership_type
enum<string>
Available options:
BRAND_OWNER,
FRANCHISEE
use_location_name
boolean

false (default): locations display the brand name on Apple Maps. true: locations keep their own name.

Controls whether preferred Google action links are pushed as Apple quicklinks the next time a location is added.

Response

Brand updated

success
boolean
payload
object