Skip to content

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

post

/email/status

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

ユーザーは、opted_inunsubscribed、または subscribed (特にオプトインまたはオプトアウトされていない) になる可能性があります。

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

前提条件

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

レート制限

Request body

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

リクエストパラメーター

パラメーター required データ型 説明
email required 文字列または配列 修正するEメールアドレスを文字列で、または最大50個までの配列で指定する。
subscription_state 必須 string subscribe”、”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!