API

連絡先のオーディエンスを設定する

1 件の連絡先がどのオーディエンスに入るかを、1 回の呼び出しで正確に指定します。連絡先は `audienceIds` のうちまだ入っていないオーディエンスすべてに参加し、それ以外のすべてから抜けます。デフォルトオーディエンスは常に保持されるので、空のリストを渡すと連絡先はデフォルトオーディエンスだけに残ります。

PUTapi.openemail.uk/contacts/{email}/audiences

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

PUT /contacts/{email}/audiences

1 件の連絡先がどのオーディエンスに入るかを、1 回の呼び出しで正確に指定します。連絡先は audienceIds のうちまだ入っていないオーディエンスすべてに参加し、それ以外のすべてから抜けます。デフォルトオーディエンスは常に保持されるので、空のリストを渡すと連絡先はデフォルトオーディエンスだけに残ります。

例

連絡先ではなくメンバーシップを書き込むため、audiences:write が必要です。@ は URL エンコードしてください。audienceIds には最大 100 個の ID を指定できます。

curl

curl -X PUT "$OE/contacts/grace%40example.com/audiences" -H "$AUTH" -H 'content-type: application/json' -d '{  "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"]}'

レスポンス

{  "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",  "audiences": [    { "id": "aud_9f2c4b7e1a0d63d84c5f2e7b", "name": "All contacts", "builtin": "default" },    { "id": "aud_4c1b8e2a7d9f05c36b4e8a71", "name": "Product updates", "builtin": null }  ]}

連絡先はあらかじめ存在している必要があります。アドレス帳にないアドレスは 404 contact_not_found になります。POST /contacts で作成してください。こちらも audienceIds を受け付けます。

このワークスペースのどのオーディエンスも指さない ID は 404 audience_not_found になり、何も変わりません。そのため、打ち間違いで誰かが黙ってリストから外れることはありません。同じ呼び出しをもう一度送っても何も変わりません。

レスポンスは GET /contacts/{email} が返すのと同じ連絡先で、変更後に属しているすべてのオーディエンスを含みます。