POST
cURL
Restricted. Requires Apple API access. Returns 403 with APPLE_API_DISABLED otherwise.
Requires an Organization token.
Adds an existing location to the brand. The location’s Google primary category must map to the same Apple category as the brand. Returns SYNCED on a successful push, or ALREADY_SYNCED if the location is already on this brand. Returns 409 if the location belongs to another brand, or if a sync is already in progress. Poll Get Apple Brand Location Sync Status until is_state_final is true if you need Apple’s published state.

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
account_id
string
required

Account that owns the location. Must belong to the caller's organization.

location_id
string
required

Existing Google Business Profile location id.

Response

SYNCED on a successful push, or ALREADY_SYNCED when re-adding the same location to the same brand

success
boolean
payload
object