POST
cURL
Restricted. Requires Apple API access. Returns 403 with APPLE_API_DISABLED otherwise.
Requires an Organization token.
Generates an Apple Business Connect OAuth URL. Redirect the user to url. After consent they are sent to your redirect_url. redirect_url must be an absolute HTTPS URL. Optional state is echoed back on the final redirect.

Success

Use company_id as apple_company_id when creating brands.

Errors

List connected companies with Get Apple OAuth Status.

Authorizations

Authorization
string
header
required

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

Body

application/json

Apple OAuth URL generation parameters

redirect_url
string<uri>
required

Absolute HTTPS URL the callback 302s back to (?success=true&state=&company_id= on success, ?error=<code> on failure).

state
string

Optional opaque partner value echoed back as state on the redirect.

Response

OAuth URL generated successfully. Redirect the user to url to begin the authorization flow.

success
boolean

Indicates if the request was successful

url
string

The generated Apple Business Connect OAuth authorization URL

state
string

OAuth session identifier. Distinct from the optional partner state sent in the request.