POST /api/v1/profile/save/

プロファイルを保存する

Adapty Mail にプロファイルを作成または更新します。プロファイルには、Adapty Mail が受信者を識別しセグメントを構築するために使用する、ユーザーのメールアドレスと属性が含まれます。

各ユーザーを安定した external_profile_id で識別してください。同じ external_profile_id を再度送信すると、重複を作成するのではなく、既存のプロファイルが更新されます。

Request body

external_profile_idstringrequired

アプリまたはバックエンドが所有するユーザーの安定した識別子です。Adapty Mail がメール、クリック、購入を一つのプロファイルに紐付けられるよう、リクエスト間で同じ値を再利用してください。匿名識別子やインストールごとの識別子は使用しないでください。

external_created_atstringrequired

ISO 8601 形式(例: "2026-06-01T10:30:00Z")のユーザー作成日時です。この日付はセグメントで使用できます。

emailstringrequired

ユーザーのメールアドレスです。Adapty Mail はこのアドレスにキャンペーンを配信します。

first_namestring

ユーザーの名前(名)です。

last_namestring

ユーザーの名前(姓)です。

genderstring

ユーザーの性別です。

birthdaystring

ISO 8601 形式(例: "1990-05-21")のユーザーの生年月日です。

countrystring

ユーザーの国を表す ISO 3166-1 alpha-2 の2文字大文字コードです(例: US)。

store_countrystring

ユーザーのストアリージョンを表す ISO 3166-1 alpha-2 の2文字大文字コードです(例: US)。

custom_attributesobject

プロファイルに付加する任意のキーと値のペア(文字列または数値)です。セグメントの構築に使用します(例: plansignup_sourcetrial_days)。

device_infoobject
platformstringrequired

ユーザーが使用しているプラットフォームです(例: iOS または Android)。

devicestring

デバイスのモデルです(例: iPhone15,2)。

osstring

オペレーティングシステムのバージョンです(例: 17.5)。

localestring

ユーザーのロケールです(例: en-US)。

timezonestring

ユーザーのタイムゾーンです(例: America/New_York)。

app_versionstring

ユーザーが実行しているアプリのバージョンです(例: 3.1.0)。

Responses

プロファイルが正常に保存されました。レスポンスボディは空のオブジェクトです。

Schema
object
Example
{}

バリデーションに失敗しました — 必須フィールドが不足しているか無効です。field_name にどのフィールドかが表示されます。

Schema

標準エラーレスポンスです。すべての失敗はこの形式で 4XX ステータスを返します。

errorsarray of object
messagestring

エラーの人間が読める説明です。

error_codestring

マシンが読み取り可能なエラー識別子です。

status_codeinteger

このエラーの HTTP ステータスコードです。

field_namestring

エラーの原因となったリクエストフィールド、またはエラーがフィールド固有でない場合は null です。

Example
{
  "errors": [
    {
      "message": "Field required",
      "error_code": "base_error",
      "status_code": 400,
      "field_name": "email"
    }
  ]
}

シークレット API キーが不足しているか無効です。

Schema

標準エラーレスポンスです。すべての失敗はこの形式で 4XX ステータスを返します。

errorsarray of object
messagestring

エラーの人間が読める説明です。

error_codestring

マシンが読み取り可能なエラー識別子です。

status_codeinteger

このエラーの HTTP ステータスコードです。

field_namestring

エラーの原因となったリクエストフィールド、またはエラーがフィールド固有でない場合は null です。

Example
{
  "errors": [
    {
      "message": "Secret key doesn't exist",
      "error_code": "secret_key_does_not_exist_error",
      "status_code": 403,
      "field_name": null
    }
  ]
}