POST
cURL
Restricted endpoint. Apple Business Connect endpoints are only available to billing accounts that have been explicitly granted access by the GMBapi team. Calling this endpoint without that permission returns 403 Forbidden with APPLE_API_DISABLED. Contact GMBapi support if you need access.
Requires an Organization token. Calling this endpoint with an Account token returns 403 Forbidden (Authorization level not found).
Links existing Apple brands to accounts (location groups). Each selection creates a brand segment, or updates the segment when that Apple brand is already linked. This does not create a brand in Apple. The brand must already exist on the company. Discover ids with List Apple Company Brands. To create a new brand in Apple, use Create Apple Brand. selections accepts 1 to 200 items. Brands you leave out stay unlinked and can be connected later with the same endpoint. If any apple_brand_id is not on Apple’s current list, the request fails and nothing is written — refresh the list and retry. A new segment is counted in segments_created. Selecting a brand that already has a segment updates it (including moving it to the account_id you send) and counts it in segments_updated. On success the company’s abc_connection_state becomes CONNECTED, including when some of its brands were left out. The response does not include segment ids. Call the list endpoint again: linked brands come back with connected: true and a segment_id you can use on the other Apple Brands endpoints.

Categories on the new segment

A newly linked segment stores Apple’s category ids (categories from the list) as primary_category, additional_categories, and apple_categories. A brand that already has a segment keeps its existing primary_category and additional_categories. apple_categories is refreshed from Apple either way. New segments are tagged provision_source: external_api. Re-linking a segment does not change the source that created it.

Responses

Authorizations

Authorization
string
header
required

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

Path Parameters

apple_company_id
string
required

Apple Business Connect company id already linked to the organization.

Body

application/json
selections
object[]
required

Brands to link. Brands omitted from this list stay unlinked.

Required array length: 1 - 200 elements

Response

Brand segments created and/or updated

success
boolean
payload
object