Connected Accounts

Connect link for Apple

Generates an Apple Business Connect OAuth link for a single location. Redirect the user to the returned url to authorize the connection; on completion Apple redirects back to your successUrl (or errorUrl on failure). The link is valid for 1 day.

Apple OAuth link variants:

Connect link for Apple — connects a single location (this endpoint; takes a locationId).
Bulk connect link for Apple — connects multiple locations in one flow (account/platform-scoped; no locationId).
Renew connect link for Apple — re-authorizes an expired or revoked token for an existing connection.

post/connected-accounts/connect-apple

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/connected-accounts/connect-apple/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Synup-Versionstring required

API version date (YYYY-MM-DD).

Authorizationstring required

API key for authentication.

Request body

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.