POST
cURL
Restricted. Requires Apple API access. Returns 403 with APPLE_API_DISABLED otherwise.
Requires an Organization token.
Creates a brand in Apple Business Connect. Required: apple_company_id (already linked to the organization), brand_name, country_code, primary_category, website_url (with protocol), and ownership_type (BRAND_OWNER or FRANCHISEE). primary_category and additional_categories are Google category ids (gcid). A country TLD that contradicts country_code is rejected. use_location_name and send_action_links apply when locations are added to the brand.

Authorizations

Authorization
string
header
required

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

Body

application/json
apple_company_id
string
required

Apple Business Connect company the brand belongs to. Must already be linked to the organization.

brand_name
string
required
country_code
string
required

ISO 3166-1 alpha-2 country code (e.g. US).

Required string length: 2
primary_category
string
required

Google category id (gcid:x, categories/gcid:x, or bare). Mapped to an Apple category server-side.

website_url
string<uri>
required

Must include a protocol. A country TLD that contradicts country_code is rejected (generic TLDs such as .com / .io are allowed).

ownership_type
enum<string>
required
Available options:
BRAND_OWNER,
FRANCHISEE
additional_categories
string[]

Additional Google category ids (max 19).

Maximum array length: 19
app_store_url
string<uri>

Optional App Store URL. Same country-TLD rule as website_url.

use_location_name
boolean
default:false

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

true: push preferred Google action links as Apple quicklinks when a location is added. false (default): do not send action links.

Response

Brand created and synced to Apple

success
boolean
payload
object