ドキュメント本文へスキップ
API

オーディエンスを空にする

1 つのトランザクションで、オーディエンスからすべての連絡先を外します。オーディエンスは ID、名前、説明とともに残り、各連絡先はアドレス帳、デフォルトオーディエンス、ほかのオーディエンスに残ります。

POSTapi.openemail.uk/audiences/{id}/empty

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

POST /audiences/{id}/empty

1 つのトランザクションで、オーディエンスからすべての連絡先を外します。オーディエンスは ID、名前、説明とともに残り、各連絡先はアドレス帳、デフォルトオーディエンス、ほかのオーディエンスに残ります。

audiences:write が必要です。ボディはありません。

curl
curl -X POST "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71/empty" -H "$AUTH"
レスポンス
{  "object": "audience",  "id": "aud_4c1b8e2a7d9f05c36b4e8a71",  "name": "Product updates",  "description": "Customers who asked to hear about releases",  "builtin": null,  "contactCount": 0,  "lastContactAt": null,  "createdAt": "2026-09-18T09:10:00.000Z",  "updatedAt": "2026-09-18T09:10:00.000Z",  "removed": 3}

レスポンスは現在の状態のオーディエンスに、外したメンバーシップの数である removed を加えたものです。すでに空のオーディエンスを空にすると removed: 0 が返ります。

取り消しはできず、誰がリストにいたかはどこにも記録されません。後で戻したくなる可能性があるなら、先に GET /audiences/{id}/contacts をたどってください。アプリはリストを空にする前に本人確認を求めますが、キーにはその手順がないため、audiences:write は慎重に付与してください。

組み込みのデフォルトオーディエンスは空にできません。その呼び出しは 409 audience_immutable で拒否されます。