Connect link for Apple

POST

https://api.synup.com/api/v4/connected-accounts/connect-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.

Request

Header Params

Body Params application/json

Example

{
    "input": {
        "locationId": "TG9jYXRpb246MQ==",
        "successUrl": "https://app.synup.com/apple/success",
        "errorUrl": "https://app.synup.com/apple/error"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.synup.com/api/v4/connected-accounts/connect-apple' \
--header 'Synup-Version: 2026-04-17' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "input": {
        "locationId": "TG9jYXRpb246MQ==",
        "successUrl": "https://app.synup.com/apple/success",
        "errorUrl": "https://app.synup.com/apple/error"
    }
}'

Responses

🟢200

application/json

Successful response

Bodyapplication/json

Example

{
    "data": {
        "connectLinkForApple": {
            "success": true,
            "url": "string",
            "errors": [
                {
                    "code": "string",
                    "message": "string",
                    "contextInfo": [
                        {}
                    ]
                }
            ],
            "clientMutationId": "string"
        }
    }
}

🟠401

Modified at 2026-07-14 18:05:30

Apple confirmed matches

Renew connect link for Apple