POST/api/v4/social/connections/disconnect

中斷連線

立即讓已連線的社群帳號離線;該帳號在帳戶共用名額池中占用的名額會保留至計費週期結束。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

請求主體

名稱類型必填說明
inputobject必填Wrapper object. The entire request body must be nested under `input`.
input.socialProfileConnectedChannelIdstring必填UUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

請求範例

可直接貼上的請求主體。請將預留位置 ID 與值換成您自己的。

Request body
{  "input": {    "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7"  }}

回應

200Connection removed.
Response
{  "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`.
Response
{  "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.

將一個已連線的社群帳號從其品牌移除。您不會直接指定品牌:連線 ID 會同時識別連線與品牌。這是單向操作,沒有可取消的時間窗口,也無法復原。若要還原該管道,請產生新的連線連結,並請使用者重新授權。

使用案例:客戶撤銷對某個管道的存取權。當客戶移除您對某個粉絲專頁的管理權限時,請中斷該管道的連線,讓排程貼文停止嘗試向其發布。從品牌的連線清單讀取 id,中斷該連線,然後重新讀取清單以確認。

注意事項。

  • 請求主體必須包在 input 物件內。欄位是 socialProfileConnectedChannelId,也就是連線本身的 UUID,不是平台的 connectedAccountId,也不是品牌 ID。
  • 請檢查 success,而非 HTTP 狀態。如果連線屬於其他品牌,或已不存在,則會傳回 HTTP 200,其中包含 success: false。回應資料不包含 ID,因此請自行記錄您要求移除的是哪個連線。
  • 請留意名稱相近的欄位。此主體欄位是 socialProfileConnectedChannelId,中間有 Profile。相鄰的洞察資料端點接受的是 socialConnectedChannelId,使用相同的 ID,但欄位名稱少一個字。這兩個名稱相差一個字,且都不接受對方的名稱。
  • 排程貼文不會被取消。已排程發布至此管道的貼文,會在發布時失敗並傳回 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"    }  }'