メール購読ステータスの変更

このエンドポイントを使用して、ユーザーのメール購読状態を設定します。

ユーザーは、opted_in 、unsubscribed 、またはsubscribed （特にオプトインまたはオプトアウトされていない）。

Braze内のどのユーザーにもまだ関連付けられていないメールアドレスのメール購読状態を設定することができます。そのEメールアドレスがその後ユーザーに関連付けられると、アップロードしたEメール購読状態が自動的に設定されます。

前提条件

このエンドポイントを使用するには、email.status パーミッションを持つAPI キーが必要です。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

リクエスト本文

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
{
  "email": "example@braze.com",
  "subscription_state": "subscribed"
}

リクエストパラメータ

リクエスト例

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/email/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "email": "example@braze.com",
  "subscription_state": "subscribed"
}'