メールサブスクリプションステータスの変更
APIMETHOD POST CORE_ENDPOINT| <div class='api_type'><div class='method post '>post</div>
/email/status
</div>
このエンドポイントを使用して、ユーザーのメール購読状態を設定する。
ユーザーは、opted_in、unsubscribed、または subscribed （特にオプトインまたはオプトアウトされていない） になる可能性があります。
Braze内のどのユーザーにもまだ関連付けられていないEメールアドレスのEメール購読状態を設定できる。その後、そのEメールアドレスがユーザーに関連付けられると、アップロードしたEメール購読状態が自動的に設定される。
前提条件
このエンドポイントを使用するには、API キーとemail.statusの権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
要求本文:
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
{
"email": "[email protected]",
"subscription_state": "subscribed"
}
リクエストパラメーター
| パラメータ | 必須 | データ型 | 説明 |
|---|---|---|---|
email |
必須 | 文字列または配列 | 修正するEメールアドレスを文字列で、または最大50個までの配列で指定する。 |
subscription_state |
必須 | 文字列 | 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"
}'
GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!