Skip to main content
MoEngage Email Subscription Management API を使用すると、MoEngage プラットフォーム内でユーザーのメール設定を直接更新できます。この API 群により、外部のメールサービスプロバイダー（ESP）と再購読ステータスを同期し、カテゴリ単位のきめ細かなオプトインを管理して、コンプライアンスの確保とユーザーエクスペリエンスの向上を実現できます。

​
エンドポイント

Email Subscription API は次のエンドポイントで構成されています。

​
API の機能

​
実装に関する注意事項

ESP のサポート:Resubscription API は現在 SendGrid のみに対応しています。update_esp が true に設定されている場合、MoEngage は SendGrid の抑制リストからメールアドレスを自動的に削除します。オプトインの ID 管理:
  • PII Tokenization: customer_id を渡す必要があります。メール ID は保存されないため、MoEngage はこれを使用してユーザーを特定します。
  • PII Encryption: customer_id または復号済みの email_id のいずれかを渡します。メール ID のみを渡した場合、そのメールに関連付けられたすべてのユーザーが更新されます。

​
よくある質問

​
再購読

MoEngage が自動的に ESP を呼び出し、リクエストで送信された受信者のメールアドレスを抑制リストから削除します。
この属性は、Email チャネルの General Settings にある、ユーザーのメールアドレスフィールドを保存する User Attribute で設定されます。MoEngage がデフォルトで使用する “Email Standard” 属性を使用するか、ユーザーのメールアドレスを保存するために任意のカスタム属性を設定できます。この属性は、各ユーザーの User Profile で確認できます。Resubscription API は、この属性を使用して受信者リスト内のメールアドレスに対応するユーザーを検索し、購読ステータスを更新します。
Email -> General Settings の Current Connector フィールドに、使用されている ESP の情報が含まれています。Resubscription API はこの情報を使用して ESP の抑制リストを更新します。
リクエストでその他の ESP が送信された場合、またはデフォルトのコネクタとして設定されている場合は、MoEngage の Unsubscribe 標準属性のみが false に更新され、ESP は更新されません（Resubscription API は Sendgrid ESP のみに対応しています）。
Email General Settings で ESP が変更された場合、設定が反映されるまで最大 15 分かかります。この時間内に再購読リクエストが実行されると、古い設定が使用されます。たとえば、ESP を Amazon から SendGrid に変更し、設定の更新から 15 分以内に再購読リクエストを実行した場合、ESP は引き続き Amazon になります。この場合、unsubscribe フラグは MoEngage ダッシュボードでのみ更新されます。
Data API は MoEngage の unsubscribe 属性のみを更新します。Resubscribe Email API は、さらに ESP（SendGrid）と同期して、抑制リストからメールを削除します。

​
オプトインとカテゴリ

メールの General Settings で指定されたユーザー属性を使用して、指定されたメール ID に一致するユーザーが検索されます。
メール ID が優先され、MoEngage は同じメール ID を持つすべてのユーザーを検索し、渡されたオプトインステータスの値で更新します。ただし、同じメール ID を持つプロファイル間でオプトインステータスや購読解除情報を引き継がないようにリクエストしている場合、MoEngage は customer_id を使用してオプトインステータスを更新します。
はい、デフォルトで引き継がれます。ユーザー A と B が同じメール ID を持ち、MoEngage が A から同意を受け取った場合、A と B の両方がダブルオプトイン済みとしてマークされます。この動作はいつでも制御できます。制御するには、MoEngage チームにお問い合わせください。
API ペイロードに、ワークスペースで有効でない、または存在しないカテゴリが 1 つでも含まれている場合、MoEngage はエラーを返し、リクエストを破棄します。
いいえ、必須ではありません。必要に応じて、いつでもグローバルレベルでトラッキングできます。
API キーのローテーションを実施しており、スムーズに移行するためにワークスペースに複数の有効な API キーがあるとします。その場合、Email Double optin に関連付けられた任意の有効な API キーを認証に使用できます。複数の API キー
この API、Resubscribe API、Update Subscription Preference API、またはエンドユーザーの操作によってユーザーのオプトインステータスが更新されるたびに、MoEngage は必要な情報を含む Email Optin Status Updated というイベントを発生させます。
  • メールに PII Tokenization を使用している場合は、Email Opt-in Management API を呼び出す際に必ずユーザー ID を渡してください。MoEngage はこのユーザー ID を使用してユーザーを特定し、オプトインステータスを更新します。この場合、MoEngage はメール ID を保存しないため、メール ID を渡しても効果はありません。
  • メールの送信に PII Encryption を使用している場合は、ユーザー ID または復号済みのメール ID のいずれかを必ず渡してください。MoEngage はこの情報を使用して、関連するユーザーを特定してオプトインステータスを更新するか、そのメール ID を持つすべてのユーザーのオプトインステータスを更新します。

​
Postman コレクション

Postman コレクションを使用して、これらの購読 API をすぐにテストできます。Postman コレクションを表示 → Resubscribe API および Email Optin Management。