Listings APIListings API
サインイン
POST/api/v4/locations/oauth-disconnect

拠点のApple Business Connect接続を解除

1つの拠点とオーナーのApple Businessアカウントとの接続を解除します。拠点はApple Mapsに残り、ListingsAPIアカウントを通じて公開されます。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

ボディ

名前型必須説明
inputobject必須Wrapper object. The entire request body must be nested under `input`.
input.locationIdstring必須Base64-encoded Relay ID of the one location to disconnect.
input.sitestring必須Set to `APPLE`.

リクエストの例

そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "APPLE"  }}

レスポンス

200Connection removed. Response key `disconnectConnectedAccountsLocations`.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to disconnect this location (`SY90003`).

クライアントが契約を終了し、Apple Businessアカウントも引き上げる場合に使用します。拠点はお使いのアカウント内とApple Maps上に残り、その後の更新はListingsAPIのApple Business Connectアカウントを通じて公開され、Appleが公開前に送信内容を検証します。その拠点の他の掲載先との接続には影響しません。

有効なApple接続がない拠点の場合はSY10057が返されるため、success: trueは接続が解除されたことを意味します。1回の呼び出しで処理するのは1つの拠点です。複数の拠点の接続を解除するには、ループで呼び出してください。

オーナーのアカウントを通じて再び公開するには、拠点をApple Business Connectに接続するから新しいリンクをオーナーに送信してください。

このページでは、1つの拠点と掲載先の接続を解除するのsite: "APPLE"の場合について説明します。

このエンドポイントは本番の接続を変更します。上記のリクエストとレスポンスはサンプルです。

Request
curl -X POST 'https://listingsapi.com/api/v4/locations/oauth-disconnect' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "site": "APPLE"    }  }'
Run in playground