Listings APIListings API
登入
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 發布更正後的公告。若要一次從所有門市移除活動，請改用大量活動的 bulk ID 刪除該大量活動。

注意事項。

  • 請求主體為選填。只有在您希望原樣傳回該值以便關聯請求時，才需傳送 clientMutationId；產生的程式碼片段包含此值作為範例。
  • 已超過排定發布時段的貼文可能會回報 status: EXPIRED，且已不再於各網站上線，但刪除該貼文仍會將其從 Listings API 清除。
  • 刪除已刪除或未知的貼文會傳回錯誤回應（{"data":null,"errors":[...]}），而非 success: true。

寫入操作：未對正式帳戶執行。所示的請求與回應是根據 API 結構描述建立的。

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"  }'
Run in playground