POST/api/v4/social/posts/cancel

取消已安排发布的帖子

在已安排发布的社交帖子发布前将其取消,不影响已发布的帖子。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

请求体

名称类型必填描述
inputobject必填Wrapper object. The entire request body must be nested under `input`.
input.socialPostIdstring必填UUID of the scheduled post to cancel.

请求示例

可直接粘贴的请求体。请将占位 ID 和值替换为您自己的。

Request body
{  "input": {    "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"  }}

响应

200The scheduled post was cancelled and will not publish.
Response
{  "data": {    "archiveScheduledPost": {      "success": true,      "error": null,      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
200The post was not in a cancellable state, most often because it has already published. The status is still 200: read `success`.
Response
{  "data": {    "archiveScheduledPost": {      "success": false,      "error": {        "message": "SY90006: Post is not scheduled and cannot be cancelled",        "code": "SY90006",        "contextInfo": null      },      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
401Unauthenticated, missing or invalid API key.
404No post with that ID on this account.

取消仍在等待发布的帖子。帖子的状态变为 ARCHIVED,发布流程会将其移除。草稿也可以用同样的方式取消;已发布的帖子则无法取消。

使用场景:客户在最后一刻撤回营销活动。 您的日历中显示着一篇已安排发布的帖子,客户改变主意后,您可以从自己的 UI 中取消它。直接从品牌的帖子列表中获取该帖子的 id,然后调用此端点;该行的状态会变为 ARCHIVED,并在下次读取时不再出现在 {"status":["SCHEDULED"]} 筛选结果中。

使用场景:断开渠道连接前先清理。 断开连接不会取消已排入该连接队列的帖子,这些帖子会在发布时失败,并返回 SY95045。先取消已安排发布的帖子,再断开连接,这样客户就不会看到任何失败。

注意事项。

  • 请求体必须封装在一个 input 对象中。
  • 检查 success,而不是 HTTP 状态。 对于已发布或已取消的帖子,端点会返回 HTTP 200,并附带 success: false。
  • 这不是删除操作。 此操作不会从任何平台移除任何内容。已发布的帖子会继续在线,此调用只会对该帖子返回 success: false。没有可撤下社交帖子的端点;移除帖子需要在平台上操作。
  • 取消操作会同时作用于帖子的所有渠道,要么全部取消,要么全部不取消。无法仅取消已安排发布的帖子在一个平台上的发布,同时让它在另一个平台上发布;如果您有此需求,请创建独立的帖子。
  • 之后仍可通过 GET /social/posts/{postId}读取该帖子,其 post.status 为 ARCHIVED。

写入操作:未在实际账户中执行。所示请求和响应根据 API schema 构建。

Request
curl -X POST 'https://listingsapi.com/api/v4/social/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'