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 schema 构建。

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"    }  }'