PATCH /api/v2/server-side-api/profile/

Update profile

Update user profile information

Header parameters

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

Your end user's first name

last_namestring

Your end user's last name

genderstring

Your end user's gender

One of: "f", "m", "o"

emailstring

Your end user's email

phone_numberstring

Your end user's phone number

birthdaystring

Your end user's birthday

ip_countrystring

Country of the end user in ISO 3166-2 format

ip_v4_addressstring

IPv4 address of the end user

store_countrystring

Country of the end user's app store

storestring

The platform the user uses to make purchases in your app

One of: "app_store", "play_store", "stripe", "adapty", "paddle"

store_account_tokenstring

Store account token

att_statusinteger

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

One of: 0, 1, 2, 3

analytics_disabledboolean

Option to opt out of external analytics

custom_attributesarray of object

Allows setting up to 30 custom attributes for the profile

keystringrequired

The key must be a string with no more than 30 characters. Only letters, numbers, dashes, points, and underscores allowed

valuestring | numberrequired

The attribute value must be no more than 50 characters. Only strings and floats are allowed as values

installation_metaobjectrequired

device_idstringrequired

Unique device identifier

devicestring

Device information

localestring

Device locale

osstring

Operating system information

platformstring

Platform (iOS, Android, etc.)

One of: "iOS", "macOS", "iPadOS", "Android", "visionOS", "web"

timezonestring

Device timezone

user_agentstring

User agent string

app_buildstring

App build version

app_versionstring

App version

adapty_sdk_versionstring

Adapty SDK version

idfastring

iOS Identifier for Advertisers

idfvstring

iOS Identifier for Vendor

advertising_idstring

Android advertising ID

android_idstring

Android device ID

android_app_set_idstring

Android app set ID

Responses

Profile updated successfully

Schema

dataobjectrequired

app_idstringrequired

The internal ID of your app

profile_idstringrequired

Adapty profile ID

customer_user_idstringrequired

The ID of your user in your system

total_revenue_usdnumberrequired

A float value representing the total revenue in USD earned in the profile

segment_hashstringrequired

Internal parameter

timestampintegerrequired

Response time in milliseconds, needs for resolve a race condition

custom_attributesarray of objectrequired

A maximum of 30 custom attributes to the profile are allowed to be set

keystringrequired

The key must be a string with no more than 30 characters. Only letters, numbers, dashes, points, and underscores allowed

valuestring | numberrequired

The attribute value must be no more than 50 characters. Only strings and floats are allowed as values

access_levelsarray of objectrequired

Array of Access level objects. Empty array if the customer has no access levels

access_level_idstring

Access level identifier

storestring

Store where the access level was purchased

store_product_idstring

Product ID in the store

store_base_plan_idstring

Base plan ID in the store

store_transaction_idstring

Transaction ID in the store

store_original_transaction_idstring

Original transaction ID in the store

offerallOf

Offer details, if a promotional or introductory offer was applied

categorystring

Offer category

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Offer type

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Offer ID

starts_atstring

When the access level starts

purchased_atstring

When the access level was purchased

originally_purchased_atstring

When the access level was originally purchased

expires_atstring

When the access level expires

renewal_cancelled_atstring

When renewal was cancelled

billing_issue_detected_atstring

When billing issue was detected

is_in_grace_periodboolean

Whether the access level is in grace period

cancellation_reasonstring

Reason for cancellation

subscriptionsarray of objectrequired

Array of Subscription objects. Empty array if the customer has no subscriptions

storestring

Store where the subscription was purchased

store_product_idstring

Product ID in the store

store_base_plan_idstring

Base plan ID in the store

store_transaction_idstring

Transaction ID in the store

store_original_transaction_idstring

Original transaction ID in the store

offerallOf

Offer details, if a promotional or introductory offer was applied

categorystring

Offer category

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

Offer type

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

Offer ID

environmentstring

Environment (Sandbox, Production)

purchased_atstring

When the subscription was purchased

originally_purchased_atstring

When the subscription was originally purchased

expires_atstring

When the subscription expires

renewal_cancelled_atstring

When renewal was cancelled

billing_issue_detected_atstring

When billing issue was detected

is_in_grace_periodboolean

Whether the subscription is in grace period

cancellation_reasonstring

Reason for cancellation

non_subscriptionsarray of objectrequired

Array of Non-Subscription objects. Empty array if the customer has no purchases

purchase_idstring

Unique purchase identifier

storestring

Store where the purchase was made

store_product_idstring

Product ID in the store

store_base_plan_idstring

Base plan ID in the store

store_transaction_idstring

Transaction ID in the store

store_original_transaction_idstring

Original transaction ID in the store

purchased_atstring

When the purchase was made

environmentstring

Environment (Sandbox, Production)

is_refundboolean

Whether this is a refund

is_consumableboolean

Whether this is a consumable purchase

Bad request

Schema

errorsarray of objectrequired

sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Unauthorized

Schema

errorsarray of objectrequired

sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Profile not found

Schema

errorsarray of objectrequired

sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Internal server error

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request PATCH \
  --url 'https://api.adapty.io/api/v2/server-side-api/profile/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/profile/', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
  },
});
const data = await response.json();

import requests

response = requests.patch('https://api.adapty.io/api/v2/server-side-api/profile/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
})
data = response.json()