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

オーディエンスを更新する

部分更新です。省略したフィールドは保存されている値を保ち、明示的な `null` は値をクリアします。組み込みのデフォルトオーディエンスも他と同じように名前や説明を変更でき、名前を変えても `builtin` も中身も変わりません。

PATCHapi.openemail.uk/audiences/{id}

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

PATCH /audiences/{id}

部分更新です。省略したフィールドは保存されている値を保ち、明示的な null は値をクリアします。組み込みのデフォルトオーディエンスも他と同じように名前や説明を変更でき、名前を変えても builtin も中身も変わりません。

audiences:write が必要です。

curl
curl -X PATCH "$OE/audiences/aud_4c1b8e2a7d9f05c36b4e8a71" -H "$AUTH" -H 'content-type: application/json' -d '{  "name": "Release notes"}'
レスポンス
{  "object": "audience",  "id": "aud_4c1b8e2a7d9f05c36b4e8a71",  "name": "Release notes",  "description": "Customers who asked to hear about releases",  "builtin": null,  "contactCount": 3,  "createdAt": "2026-09-18T09:10:00.000Z",  "updatedAt": "2026-09-18T09:22:00.000Z"}

builtin はここから設定も移動もクリアもできません。

名前を変えても誰も移動しません。連絡先は新しい名前のオーディエンスにそのまま残り、id が変わることはありません。