---
title: "Connect link for Apple"
method: POST
path: "/connected-accounts/connect-apple"
tags: ["Connected Accounts"]
---

# Connect link for Apple

`POST /connected-accounts/connect-apple`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/connected-accounts/connect-apple`
- 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)

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.

## Headers

- `Synup-Version` string, required
- `Authorization` string, required

## Request body

- AppleOauthRequestV2
  - `input` object, required
    - `locationId` string, required: Relay-encoded location ID to connect.
    - `successUrl` string, required: Redirect URL on successful authorization.
    - `errorUrl` string, required: Redirect URL on failed authorization.
    - `clientMutationId` string

## Response `200`

Successful response

- object
  - `data` object
    - `connectLinkForApple` AppleOauthPayloadV2
      - `success` boolean
      - `url` string: OAuth link to redirect the user to (1-day TTL).
      - `errors` MutationErrorV2[]
        - `code` string
        - `message` string
        - `contextInfo` object[]
      - `clientMutationId` string

## Other responses

- `401`: Unauthorized - Invalid or missing API key

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)