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,發布流程也會將其排除。草稿也可以用相同方式取消;已發布的貼文則無法取消。

使用案例:客戶在最後一刻撤回行銷活動。 您的行事曆上有一則排程貼文,客戶改變心意後,您便從自己的使用者介面取消該貼文。直接從品牌的貼文清單取得該貼文的 id,並呼叫此端點;該資料列會轉為 ARCHIVED,下次讀取時便不會出現在 {"status":["SCHEDULED"]} 篩選結果中。

使用案例:中斷管道連線前先清理。 中斷連線不會取消已排入該連線佇列的貼文,這些貼文反而會在發布時失敗,並傳回 SY95045。先取消排程貼文,再中斷連線,客戶就完全不會看到任何失敗。

注意事項。

  • 請求主體必須包在 input 物件中。
  • 請檢查 success,而非 HTTP 狀態。 對於已發布或已取消的貼文,此端點會傳回 HTTP 200,其中包含 success: false。
  • 這不是刪除操作。 任何平台上的內容都不會被移除。已發布的貼文會繼續公開顯示,而此呼叫只會針對該貼文回報 success: false。沒有可將社群貼文下架的端點;移除貼文必須在平台本身操作。
  • 取消操作會一併套用至該貼文的所有管道。無法只取消某個平台上的排程貼文,同時讓它在另一個平台發布;若您有此需求,請建立個別貼文。
  • 之後仍可透過 GET /social/posts/{postId} 讀取該貼文,其 post.status 為 ARCHIVED。

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

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