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

オーディエンスから連絡先を一括で外す

アドレスを指定して、1 回の呼び出しで最大 200 件の連絡先を 1 つのオーディエンスから外します。どの連絡先もアドレス帳、デフォルトオーディエンス、それまで入っていたほかのすべてのオーディエンスに残ります。

POSTapi.openemail.uk/audiences/{id}/contacts/batch-remove

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

POST /audiences/{id}/contacts/batch-remove

アドレスを指定して、1 回の呼び出しで最大 200 件の連絡先を 1 つのオーディエンスから外します。どの連絡先もアドレス帳、デフォルトオーディエンス、それまで入っていたほかのすべてのオーディエンスに残ります。

audiences:write が必要です。ボディの形は一括追加と同じで、1〜200 個のアドレスを入れた emails です。

curl
curl -X POST "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71/contacts/batch-remove" -H "$AUTH" -H 'content-type: application/json' -d '{  "emails": ["[email protected]", "[email protected]", "[email protected]"]}'
レスポンス
{  "object": "audience_batch",  "audienceId": "aud_4c1b8e2a7d9f05c36b4e8a71",  "removed": 1,  "notInAudience": ["[email protected]"],  "missing": ["[email protected]"]}

removed は外したメンバーシップを数え、notInAudience はこのオーディエンスにいなかった連絡先を、missing はそもそも連絡先でないアドレスを列挙します。どちらのリストにも何も起きないので、この呼び出しは再実行しても安全です。

組み込みのデフォルトオーディエンスは減らせません。呼び出しは 409 audience_immutable で拒否され、何も外されません。連絡先そのものを消したいときは、連絡先を削除してください。