API

オーディエンスを作成する

空の新しいオーディエンスを作成し、その id とともに返します。`name` はトリムされ、その後 1 〜 120 文字である必要があります。`description` は任意の自由記述で、後からリストを見る人のためのものです。オーディエンスは id で指定するため、名前の重複はチェックされません。

POSTapi.openemail.uk/audiences

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

POST /audiences

空の新しいオーディエンスを作成し、その id とともに返します。name はトリムされ、その後 1 〜 120 文字である必要があります。description は任意の自由記述で、後からリストを見る人のためのものです。オーディエンスは id で指定するため、名前の重複はチェックされません。

例

audiences:write が必要です。

curl

curl -X POST "$OE/audiences" -H "$AUTH" -H 'content-type: application/json' -d '{  "name": "Product updates",  "description": "Customers who asked to hear about releases"}'

レスポンス

{  "object": "audience",  "id": "aud_4c1b8e2a7d9f05c36b4e8a71",  "name": "Product updates",  "description": "Customers who asked to hear about releases",  "builtin": null,  "contactCount": 0,  "createdAt": "2026-09-18T09:10:00.000Z",  "updatedAt": "2026-09-18T09:10:00.000Z"}

builtin はボディから受け付けられることがありません。ワークスペースごとにちょうど 1 行だけがこれを持ち、その行はサーバーが所有します。

1 つのワークスペースが持てるオーディエンスは最大 100 件です。それを超えると name に対する 422 audience_limit_reached で拒否されます。

中身は追加ルートで連絡先を 1 件ずつ入れていきます。連絡先は事前にアドレス帳にある必要があります。