v1

latestOpenAPI 3.1.02026-08-061945115.8 KB

Profile

Update profile

Update user profile information

patch/api/v2/server-side-api/profile/

Headers

adapty-customer-user-idstring

The unique ID of the customer in your system. Either adapty-customer-user-id or adapty-profile-id is required.

adapty-profile-idstring

The unique ID of the profile in your system. Your best option if you are working with anonymous profiles. Either adapty-customer-user-id or adapty-profile-id is required.

Request body

first_namestring nullable

Your end user's first name

last_namestring nullable

Your end user's last name

gender'f' | 'm' | 'o' nullable

Your end user's gender

emailstring email nullable

Your end user's email

phone_numberstring nullable

Your end user's phone number

birthdaystring date nullable

Your end user's birthday

ip_countrystring nullable

Country of the end user in ISO 3166-2 format

ip_v4_addressstring nullable

IPv4 address of the end user

store_countrystring nullable

Country of the end user's app store

store'app_store' | 'play_store' | 'stripe' | 'adapty' | 'paddle' nullable

The platform the user uses to make purchases in your app

store_account_tokenstring uuid nullable

Store account token

att_status0 | 1 | 2 | 3 nullable

Apple App Tracking Transparency status (0=not determined, 1=restricted, 2=denied, 3=authorized)

analytics_disabledboolean nullable

Option to opt out of external analytics

Example request

{
  "first_name": "Jane",
  "last_name": "Doe",
  "gender": "f",
  "email": "jane.doe@example.com",
  "phone_number": "+1234567890",
  "birthday": "2000-12-31",
  "ip_country": "FR",
  "ip_v4_address": "192.168.1.1",
  "store_country": "US",
  "store": "app_store",
  "store_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "att_status": 3,
  "analytics_disabled": true,
  "custom_attributes": [
    {
      "key": "favourite_sport",
      "value": "yoga"
    }
  ],
  "installation_meta": {
    "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "device": "iPhone 15 Pro",
    "locale": "en",
    "os": "iOS 17.1",
    "platform": "iOS",
    "timezone": "Europe/Rome",
    "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_1_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.1 Mobile/15E148 Safari/604.1",
    "app_build": "1.0.0",
    "app_version": "1.0.0",
    "adapty_sdk_version": "2.0.0",
    "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
    "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
    "advertising_id": "",
    "android_id": "",
    "android_app_set_id": ""
  }
}

Response

Profile updated successfully