DELETE/api/v4/posts/{postId}

删除帖子

永久删除社交帖子营销活动,并从发布该帖子的所有站点移除帖子。

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

参数

路径

名称类型必填描述
postIdstring必填Base64-encoded social post ID to delete (the `id` from a posts list or the create response).

请求体

名称类型必填描述
clientMutationIdstring可选Optional client-supplied token returned unchanged in the response, for correlating the request.

请求示例

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

Request body
{  "clientMutationId": "delete-44122-req-1"}

响应

200Post deleted. `socialPostId` returns the deleted post's ID.
Response
{  "data": {    "deleteSocialPost": {      "success": true,      "socialPostId": "U29jaWFsUG9zdDo0NDEyMg=="    }  }}
401Unauthenticated, missing or invalid API key.

删除指定的帖子营销活动。此操作是永久性的:帖子将从 Listings API 中移除,并且从已发布到的所有站点(Google、Facebook)撤下。删除已上线的帖子会将其从已连接的商家资料中撤下,且无法撤销。

使用场景:撤回有误的公告。 如果已发布的公告中营业时间有误,请使用 DELETE /posts/{postId} 删除公告(使用帖子列表中的 id),确认 success: true,然后使用 POST /posts 发布更正后的公告。要一次性从所有门店移除营销活动,请改用批量营销活动的批量 ID 将其删除。

注意事项。

  • 请求体为可选项。仅当您希望原样返回该值以便关联请求时,才发送 clientMutationId;生成的代码片段将其作为示例包含在内。
  • 计划展示时段已结束的帖子可能会报告 status: EXPIRED,且已不再在各站点上展示,但删除操作仍会将其从 Listings API 中清除。
  • 删除已被删除或不存在的帖子会返回错误响应({"data":null,"errors":[...]}),而非 success: true。

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

Request
curl -X DELETE 'https://listingsapi.com/api/v4/posts/<postId>' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "clientMutationId": "delete-44122-req-1"  }'