POSTapi.synup.com/api/v4/connected-accounts/connect-apple

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.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Body

Name	Type	Required	Description
`input`	object	required
`input.locationId`	string	required	Relay-encoded location ID to connect.
`input.successUrl`	string	required	Redirect URL on successful authorization.
`input.errorUrl`	string	required	Redirect URL on failed authorization.
`input.clientMutationId`	string	optional

Request

curl -X POST 'https://api.synup.com/api/v4/connected-accounts/connect-apple' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "locationId": "TG9jYXRpb246MQ==",
    "successUrl": "https://app.synup.com/apple/success",
    "errorUrl": "https://app.synup.com/apple/error"
  }
}'

const res = await fetch('https://api.synup.com/api/v4/connected-accounts/connect-apple', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "input": {
      "locationId": "TG9jYXRpb246MQ==",
      "successUrl": "https://app.synup.com/apple/success",
      "errorUrl": "https://app.synup.com/apple/error"
    }
  }),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/connected-accounts/connect-apple",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "input": {
        "locationId": "TG9jYXRpb246MQ==",
        "successUrl": "https://app.synup.com/apple/success",
        "errorUrl": "https://app.synup.com/apple/error"
      }
    },
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/connected-accounts/connect-apple", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`401`	Unauthorized - Invalid or missing API key

Example response (generated from the schema)

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

Response body

Name	Type	Required	Description
`data`	object	optional
`data.connectLinkForApple`	object	optional
`data.connectLinkForApple.success`	boolean	optional
`data.connectLinkForApple.url`	string	optional	OAuth link to redirect the user to (1-day TTL).
`data.connectLinkForApple.errors`	array of object	optional
`data.connectLinkForApple.errors[].code`	string	optional
`data.connectLinkForApple.errors[].message`	string	optional
`data.connectLinkForApple.errors[].contextInfo`	array of object	optional
`data.connectLinkForApple.clientMutationId`	string	optional