API

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

すでにワークスペースのアドレス帳にあるアドレスを受け取り、そのメンバーシップを、指し示す連絡先とともに返します。メンバーシップはオーディエンスと連絡先の組み合わせごとに 1 つなので、すでにオーディエンスに入っている相手を追加した場合は、2 つ目を作ったり失敗したりせず、元の `addedAt` を添えて `200` を返します。そのため、この呼び出しは安全に再試行できます。

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

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

POST /audiences/{id}/contacts

すでにワークスペースのアドレス帳にあるアドレスを受け取り、そのメンバーシップを、指し示す連絡先とともに返します。メンバーシップはオーディエンスと連絡先の組み合わせごとに 1 つなので、すでにオーディエンスに入っている相手を追加した場合は、2 つ目を作ったり失敗したりせず、元の addedAt を添えて 200 を返します。そのため、この呼び出しは安全に再試行できます。

例

audiences:write が必要です。

curl

curl -X POST "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71/contacts" -H "$AUTH" -H 'content-type: application/json' -d '{  "email": "[email protected]"}'

レスポンス

{  "object": "audience_member",  "audienceId": "aud_4c1b8e2a7d9f05c36b4e8a71",  "addedAt": "2026-09-18T09:30:00.000Z",  "contact": {    "object": "contact",    "email": "[email protected]",    "name": "Grace Hopper",    "source": "manual",    "notes": null,    "lastSeenAt": null,    "createdAt": "2026-09-18T09:00:00.000Z",    "updatedAt": "2026-09-18T09:00:00.000Z"  }}

連絡先ではないアドレスは、その場で作成されるのではなく 422 contact_not_found で拒否されます。先に POST /contacts で保存してください。

チェックされるスコープは audiences:write だけです。連絡先をリストに入れることは、連絡先への書き込みではありません。

連絡先 1 件につき 1 回の呼び出しです。このバージョンには一括追加はなく、後で連絡先を削除すると、このメンバーシップも一緒に失われます。