Adapty Mail APIでメールとトランザクションを送信する

Adapty Mail APIを使うと、Adapty SDKを経由せずに、サーバーから直接Adapty Mailにユーザープロファイルとトランザクションを送信できます。以下のような場合に活用してください：

• Adapty Mail にまだベースがない場合に購読者を追加する。
• 他のアプリの購読者ベースを再利用する。
• バックエンドを信頼できる情報源として、Adapty Mail をサーバー間通信で連携する。

始める前に

APIキーとベースURLも必要です：

• シークレットAPIキー: Adapty Mailの Settings に移動し、シークレットAPIキーをコピーします。キーはプロジェクト固有であるため、APIはどのプロジェクトのデータかを識別できます。
• ベースURL: すべてのリクエストは https://api-mail.adapty.io に送信します。
• 認証: Authorization ヘッダーに Bearer {your_secret_api_key} の形式でキーを送信します。

ユーザープロファイルを送信する

プロファイルには、ユーザーのメールアドレスと属性が含まれます。プロファイルを作成または更新するには、/api/v1/profile/save/ にPOSTリクエストを送信します。

以下の3つのフィールドが必須です：

• アプリまたはバックエンドが管理する安定した external_profile_id
• Adapty Mailがキャンペーンを配信する email
• ユーザー作成日時を示す external_created_at（セグメントで使用可能）

同じユーザーが Adapty SDK 経由でも Adapty Mail に到達する場合は、customer_user_id（Adapty.identify() に渡す独自のユーザー ID）を追加してください。Adapty Mail はこの ID で照合し、重複プロファイルを作成してそのユーザーに二重でメールを送る代わりに、両方のソースを1つのプロファイルにまとめます。

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/save/' \
  --header 'Authorization: Bearer {your_secret_api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_profile_id": "user_12345",
    "external_created_at": "2026-06-01T10:30:00Z",
    "email": "jane@example.com",
    "country": "US",
    "custom_attributes": {
      "plan": "trial"
    }
  }'

利用可能なすべてのフィールドについては、プロファイルを保存するのリファレンスを参照してください。

トランザクションイベントを送信する

一度も購入していないフローを除くすべてのフローは、購入履歴によって動作します。購入、更新、キャンセルを処理する際にトランザクションイベントを送信することで、Adapty Mailはプロファイルを適切なフローに振り分けられます。トランザクションイベントは収益アトリビューションにも活用されます。一度も購入していないキャンペーンのみを実施する場合は省略できます。

トランザクションを記録するには、/api/v1/profile/transaction-event/save/ にPOSTリクエストを送信します。プロファイルの送信時と同じ external_profile_id を使用することで、Adapty Mailがトランザクションを正しいユーザーに紐付けられます。

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/transaction-event/save/' \
  --header 'Authorization: Bearer {your_secret_api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "event_type": "subscription_started",
    "event_id": "evt_abc123",
    "event_datetime": "2026-06-10T14:20:05Z",
    "external_profile_id": "user_12345",
    "store": "app_store",
    "store_product_id": "premium_monthly",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "purchased_at": "2026-06-10T14:20:00Z",
    "originally_purchased_at": "2026-06-10T14:20:00Z",
    "price_usd": "9.99"
  }'

Save transaction event リファレンスで利用可能なすべてのフィールドを確認できます。

プロファイルが存在する前にトランザクションを送信することもできます。Adapty Mail はそのイベントを未紐付けの状態で保持し、同じ external_profile_id を含む次の保存時にプロファイルへ紐付けます。

プロファイルの削除

削除権（忘れられる権利）のリクエストに対応するには、プロファイルの識別子を /api/v1/profile/delete/ に送信してください。Adapty Mail はプロファイルの個人データを消去し、スケジュールされたメールをキャンセルします。

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/delete/' \
  --header 'Authorization: Bearer {your_secret_api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_profile_id": "user_12345"
  }'

external_profile_id、customer_user_id、または email でプロファイルを識別します — 少なくとも1つを送信してください。削除は元に戻せません。同じ識別子を持つ後続の保存リクエストでは、プロファイルは再作成されません。

リトライを安全に行うには、external_profile_id または customer_user_id でプロファイルを識別してください。email のみで実行した削除を繰り返すと 404 が返されます。削除によってメールアドレスが消去されるためです。詳細はプロファイルの削除リファレンスをご参照ください。

イベントをフローにマッピングする

発生した内容に合った event_type を送信してください。Adapty Mailはイベント履歴からプロファイルの状態を導き出し、対応するフローにルーティングします。