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

# Renew connect link for Apple

`POST /connected-accounts/connect-apple/renew`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/connected-accounts/connect-apple/renew`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/connected-accounts/connect-apple/renew/post.ts> (a function with typed inputs; its response is checked against the schema)

Generates a link to **re-authorize** an Apple Business Connect connection whose OAuth token has expired or been revoked. Provide either a `locationId` or a `connectedAccountId` to identify the connection to renew. Redirect the user to the returned `url`; the link is valid for 1 day.

**Apple OAuth link variants:**
- **Connect link for Apple** — connect a single location.
- **Bulk connect link for Apple** — connect multiple locations.
- **Renew connect link for Apple** — re-authorize an existing connection (this endpoint).

## Headers

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

## Request body

- AppleRenewOauthRequestV2
  - `input` object, required
    - `locationId` string: Relay-encoded location ID of the connection to renew.
    - `connectedAccountId` string: ID of the connected Apple account to renew (alternative to locationId).
    - `successUrl` string, required: Redirect URL on successful re-authorization.
    - `clientMutationId` string

## Response `200`

Successful response

- object
  - `data` object
    - `renewConnectLinkForApple` AppleRenewOauthPayloadV2
      - `success` boolean
      - `url` string: OAuth renewal 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)