POST
/api/v4/social/connections/disconnect接続を解除する
接続済みのソーシャルアカウントを直ちにオフラインにします。その接続枠は、アカウント全体で共有するプール内で請求期間の終了まで確保されます。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input | object | 必須 | Wrapper object. The entire request body must be nested under `input`. |
| input.socialProfileConnectedChannelId | string | 必須 | UUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections. |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "input": { "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7" }}レスポンス
200Connection removed.
{ "data": { "disconnectSocialConnectedChannel": { "success": true, "error": null } }}200The connection could not be removed, most often because it belongs to a different brand (`SY95052`) or has already been disconnected. The status is still 200: read `success`.
{ "data": { "disconnectSocialConnectedChannel": { "success": false, "error": { "message": "SY95052: Connected channel does not belong to this brand", "code": "SY95052", "contextInfo": null } } }}401Unauthenticated, missing or invalid API key.
接続済みのソーシャルアカウントを1つ、そのブランドから削除します。ブランドは直接指定しません。接続IDで両方を特定します。これは一方向の操作であり、キャンセルできる猶予期間も、元に戻す機能もありません。チャネルを復元するには、新しい接続リンクを発行し、ユーザーに再認可してもらいます。
ユースケース:クライアントが1つのチャネルへのアクセスを取り消す場合。 顧客がページの管理権限を取り消した場合は、そのチャネルの接続を解除し、予約投稿がそのチャネルへの公開を試みないようにします。ブランドの接続一覧からidを読み取り、その接続を解除してから、一覧を再取得して確認します。
注意事項。
- リクエストボディは
inputオブジェクトでラップする必要があります。フィールドはsocialProfileConnectedChannelIdで、接続自体のUUIDを指定します。プラットフォームのconnectedAccountIdでも、ブランドIDでもありません。 - HTTPステータスではなく、
successを確認してください。 別のブランドに属する接続、またはすでに存在しない接続の場合、HTTP 200とsuccess: falseが返されます。ペイロードにはIDが含まれないため、どの接続の削除を要求したかを自分で記録しておいてください。 - よく似た名前に注意してください。 このリクエストボディフィールドは
socialProfileConnectedChannelIdで、途中にProfileが入ります。隣接するインサイトエンドポイントはsocialConnectedChannelIdを受け取ります。指定するIDは同じですが、フィールド名が1語短く、どちらも相手のフィールド名は受け付けません。 - 予約投稿はキャンセルされません。 このチャネルへの公開が予約されていた投稿は破棄されず、公開時に
SY95045で失敗します。失敗を避けたい場合は、先にPOST /social/posts/cancelでキャンセルしてください。 - 公開済みの投稿は公開されたままです。 接続を解除すると、listingsAPIは投稿の公開とインサイトの読み取りができなくなりますが、プラットフォーム上のデータは何も削除されません。
- 接続枠がプールに戻るのは、呼び出しの成功時ではなく契約更新時です。
GET /social/limitsには、この状態がusage.connectionsActiveの減少とusage.connectionsReleasedの増加として直ちに反映されますが、上限が適用される課金対象の数であるusage.connectionsは、請求期間が切り替わるまで変わりません。usage.connectionsReleasedは、契約更新時に戻る接続枠の数です。プランとアドオンを参照してください。 - 同じアカウントを同じブランドに再接続する場合は無料です。 同じ期間内にそのブランドから接続を解除したソーシャルアカウントを再接続すると、既存の接続枠が再利用され、
connectionsReleasedからconnectionsActiveに戻り、課金対象のconnectionsは変わりません。接続枠はブランドとアカウントの組み合わせごとに確保されるため、別のソーシャルアカウントには新しい接続枠が必要であり、同じアカウントでも別のブランドに接続する場合は同様です。 - ブランドをアーカイブすると、そのブランドのすべての接続が解除されるため、アーカイブする際にこの呼び出しを先に行う必要はありません。その場合も接続枠は期間の終了まで確保され、解除方法による違いはありません。
書き込み操作:実際のアカウントに対しては実行していません。表示されているリクエストとレスポンスは、APIスキーマに基づいて作成されています。
Request
curl -X POST 'https://listingsapi.com/api/v4/social/connections/disconnect' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7" } }'