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)で公開が停止されます。公開中の投稿を削除すると、接続されているプロフィールからも削除され、元に戻すことはできません。

ユースケース:誤ったお知らせを取り下げる。 誤った営業時間を記載したお知らせを公開してしまった場合は、投稿一覧の id を使って DELETE /posts/{postId} で削除し、success: true を確認してから、POST /posts で修正版を公開します。すべての店舗からキャンペーンを一度に削除するには、代わりに一括キャンペーンの一括 ID を使って削除します。

注記。

  • リクエストボディは省略可能です。リクエストの対応付けのために値をそのまま返す必要がある場合にのみ、clientMutationId を送信してください。生成されたスニペットには、例としてこれが含まれています。
  • 設定された公開期間がすでに終了した投稿は、status: EXPIRED と報告され、各サイトで公開されていない場合がありますが、削除すれば Listings API からは消去されます。
  • 削除済みの投稿または不明な投稿を削除すると、success: true ではなくエラーレスポンス({"data":null,"errors":[...]})が返されます。

書き込み操作:実際のアカウントに対しては実行されていません。表示されているリクエストとレスポンスは、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"  }'