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

オーディエンスに連絡先を一括追加する

アドレスを指定して、1 回の呼び出しで最大 200 件の連絡先を 1 つのオーディエンスに入れます。単体の追加と同じく、ワークスペースのアドレス帳にすでにあるアドレスだけを受け付け、連絡先は決して作成しません。連絡先でないアドレスは `missing` で返され、それについては何も書き込まれませんが、呼び出しの残りはそのまま処理されます。

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

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

POST /audiences/{id}/contacts/batch

アドレスを指定して、1 回の呼び出しで最大 200 件の連絡先を 1 つのオーディエンスに入れます。単体の追加と同じく、ワークスペースのアドレス帳にすでにあるアドレスだけを受け付け、連絡先は決して作成しません。連絡先でないアドレスは missing で返され、それについては何も書き込まれませんが、呼び出しの残りはそのまま処理されます。

audiences:write が必要です。emails には 1〜200 個のアドレスを入れ、照合の前に前後の空白が除かれ小文字に変換されます。

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

added は新しいメンバーシップ、unchanged はすでにオーディエンスにいた連絡先を数え、missing は連絡先でないアドレスを小文字で重複なく列挙します。それらは POST /contacts で保存するか、作成まで行う POST /audiences/{id}/import に送ってください。

再実行しても安全です。同じ呼び出しを 2 回目に送っても何も追加されず、全員が unchanged として報告されます。デフォルトオーディエンスへの追加は常に added: 0 を返します。すべての連絡先がすでに入っているからです。

emails が空、アドレスが 200 個を超える、またはボディにほかのキーがある場合は 422 になり、何も書き込まれません。