Skip to content

メールサブスクリプションステータスの変更

post

/email/status

このエンドポイントを使用して、ユーザーのメールサブスクリプション状態を設定します。

ユーザーは opted_inunsubscribed、または subscribed(特にオプトインまたはオプトアウトされていない状態)に設定できます。

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

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限(1時間あたり250,000リクエスト)が適用されます。

リクエスト本文

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
{
  "email": "[email protected]",
  "subscription_state": "subscribed"
}

リクエストパラメーター

パラメーター 必須 データタイプ 説明
email 必須 文字列または配列 変更するメールアドレスの文字列、または最大50件のメールアドレスの配列。
subscription_state 必須 文字列 “subscribed”、”unsubscribed”、または “opted_in” のいずれか。

リクエスト例

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": "[email protected]",
  "subscription_state": "subscribed"
}'
New Stuff!