POST
/api/v4/social/posts/cancel予約投稿をキャンセルする
公開前の予約済みソーシャル投稿をキャンセルし、公開済みの投稿には変更を加えません。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input | object | 必須 | Wrapper object. The entire request body must be nested under `input`. |
| input.socialPostId | string | 必須 | UUID of the scheduled post to cancel. |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "input": { "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345" }}レスポンス
200The scheduled post was cancelled and will not publish.
{ "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`.
{ "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オブジェクトでラップする必要があります。 - HTTPステータスではなく、
successを確認してください。 投稿が公開済み、またはキャンセル済みの場合は、success: falseを伴うHTTP 200が返されます。 - この操作は削除ではありません。 どのプラットフォームからも何も削除されません。公開済みの投稿は公開されたままとなり、この呼び出しではその投稿について
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" } }'