オーディエンスに送信

1 つ以上のオーディエンス内の全員に 1 通のメッセージを、一人ずつ別のコピーとして、各連絡先に合わせてパーソナライズして送ります。各コピーの受信者はちょうど一人で cc も bcc もないため、他に誰に送られたかは誰にも見えず、各コピーは独自の msg_ ID、イベント、トラッキング、Webhook を持つ普通のメールです。呼び出しはすぐに 202 を返し、送信はバックグラウンドで続くので、GET /broadcasts/{id} で追跡してください。

emails:send と audiences:read が必要です。audienceIds には 1〜10 個の ID を入れます。本文は html と text のどちらかまたは両方、あるいは保存済みの template から取り、両方を使うことはできません。subject はテンプレートが用意しない限り必須です。

curl -X POST "$OE/broadcasts" -H "$AUTH" -H 'content-type: application/json' -d '{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "html": "<p>Hi {{firstName|there}},</p><p>Here is what changed this month.</p>",  "text": "Hi {{firstName|there}}, here is what changed this month. Unsubscribe: {{unsubscribeUrl}}",  "tags": { "campaign": "release-2026-09" },  "scheduledAt": "PT2H"}'

{  "object": "broadcast",  "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",  "status": "scheduled",  "mode": "live",  "source": "api",  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],  "from": "Acme <[email protected]>",  "subject": "{{firstName|Hello}}, the September release is out",  "counts": {    "recipients": 412,    "created": 0,    "skipped": 0,    "failedToQueue": 0,    "queued": 0,    "sending": 0,    "sent": 0,    "failed": 0,    "cancelled": 0  },  "lastError": null,  "scheduledAt": "2026-09-23T14:00:00.000Z",  "startedAt": null,  "completedAt": null,  "cancelledAt": null,  "createdAt": "2026-09-23T12:00:00.000Z",  "updatedAt": "2026-09-23T12:00:00.000Z",  "replayed": false}

少なくとも 1 つのオーディエンスに入っているすべての連絡先で、いくつのオーディエンスに入っていても 1 回だけ数えます。除外されるのは 2 種類の連絡先です。選んだオーディエンスのうち自分が入っているすべてで配信停止したものと、バウンスや苦情のため、あるいは誰かが追加したために抑止リストにアドレスがあるものです。呼び出し後、送信がその連絡先に届く前にオーディエンスに追加された連絡先には届きます。

送信はオーディエンスを 50 人ずつ進み、各コピーを POST /emails と同じ経路に渡すので、各コピーは他のメッセージと同じように再試行、追跡、報告されます。POST /broadcasts/preview は、この呼び出しの出発点となる人数を、何も送らずに返します。

subject、html、text は一人ひとりについて埋められます。各項目はバーの後に代替値を取り、連絡先に値がないときに使われるので、名前なしで保存された連絡先では {{firstName|there}} が "there" になります。html では値がエスケープされ、波かっこ内の空白は許され、他の {{…}} は書かれたとおりに残ります。

本文の代わりに template を使うと、同じ 5 つの値がプロパティとして渡されますが、テンプレートが宣言しているプロパティに限られます。firstName を宣言しているテンプレートはそれを受け取り、宣言していないプロパティは送られないので、コピーが未知のプロパティで失敗することはありません。template.props に入れたものはすべてのコピーに同じように入ります。

どのコピーにも List-Unsubscribe と List-Unsubscribe-Post: List-Unsubscribe=One-Click が付きます。これによってメールクライアントが独自の配信停止ボタンを表示でき、大手のメールボックス事業者が一括メールに求めているのもこれです。

{{unsubscribeUrl}} を自分で置いていない html または text の本文には、1 行のフッターが付きます: "You are receiving this because you are on this mailing list. Unsubscribe"。テンプレートはそのまま送られるので、テンプレートに {{unsubscribeUrl}} を入れてください。

リンクは配信停止ボタンのあるページを開くので、リンクを取得するスキャナーは誰も配信停止にしませんが、メールクライアントのワンクリック要求はすぐに配信停止にします。どちらの場合も、その人はこの一斉配信が送られたすべてのオーディエンスで配信停止として記録され、GET /audiences/{id}/contacts に unsubscribedAt として表れます。他のオーディエンス、連絡先、1 通ずつ送るメールには影響しません。