このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。
メール購読ステータスの変更
このエンドポイントを使用して、ユーザーのグローバルなメール購読状態を設定します。
ユーザーはopted_in、unsubscribed、または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”のいずれか。 |
SendGridメールブロックのトラブルシューティング
SendGridが受信者をブロックした場合、このエンドポイントで購読ステータスを更新し、セグメントフィルターでエンゲージメントを確認してください。配信到達性の監視にはCurrentsのソフトバウンスイベントを使用し、再送信前に購読状態を確認してください。
リクエスト例
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!