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

Обновить профиль

Обновляет информацию профиля пользователя

Header parameters

adapty-customer-user-idstring

Уникальный идентификатор пользователя в вашей системе. Требуется либо adapty-customer-user-id, либо adapty-profile-id.

adapty-profile-idstring

Уникальный идентификатор профиля в вашей системе. Оптимальный вариант при работе с анонимными профилями. Требуется либо adapty-customer-user-id, либо adapty-profile-id.

Request body

first_namestring

Имя вашего конечного пользователя

last_namestring

Фамилия вашего конечного пользователя

genderstring

Пол вашего конечного пользователя

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

emailstring

Электронная почта вашего конечного пользователя

phone_numberstring

Номер телефона вашего конечного пользователя

birthdaystring

Дата рождения вашего конечного пользователя

ip_countrystring

Страна конечного пользователя в виде двухбуквенного кода ISO 3166-1 alpha-2, например FR

ip_v4_addressstring

IPv4-адрес конечного пользователя

store_countrystring

Страна стора конечного пользователя в виде двухбуквенного кода ISO 3166-1 alpha-2, например US

storestring

Платформа, которую пользователь использует для совершения покупок в вашем приложении

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

store_account_tokenstring

Токен аккаунта стора

att_statusinteger

Статус Apple App Tracking Transparency (0=не определено, 1=ограничено, 2=отклонено, 3=авторизовано)

One of: 0, 1, 2, 3

analytics_disabledboolean

Опция отказа от внешней аналитики

custom_attributesarray of object

Позволяет задать до 30 пользовательских атрибутов для профиля

keystringrequired

Ключ должен быть строкой не более 30 символов. Допускаются только буквы, цифры, дефисы, точки и символы подчёркивания

valuestring | numberrequired

Значение атрибута должно содержать не более 50 символов. В качестве значений допускаются только строки и числа с плавающей точкой

installation_metaobjectrequired

device_idstringrequired

Уникальный идентификатор устройства

devicestring

Информация об устройстве

localestring

Локаль устройства

osstring

Информация об операционной системе

platformstring

Платформа (iOS, Android и т.д.)

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

timezonestring

Часовой пояс устройства

user_agentstring

Строка user agent

app_buildstring

Версия сборки приложения

app_versionstring

Версия приложения

adapty_sdk_versionstring

Версия SDK Adapty

idfastring

iOS Identifier for Advertisers

idfvstring

iOS Identifier for Vendor

advertising_idstring

Идентификатор рекламы Android

android_idstring

Идентификатор устройства Android

android_app_set_idstring

Идентификатор набора приложений Android

Responses

Профиль успешно обновлён

Schema

dataobjectrequired

app_idstringrequired

Внутренний ID вашего приложения

profile_idstringrequired

ID профиля Adapty

customer_user_idstringrequired

ID вашего пользователя в вашей системе

total_revenue_usdnumberrequired

Числовое значение с плавающей точкой, представляющее общий доход в USD, полученный по профилю

segment_hashstringrequired

Внутренний параметр

timestampintegerrequired

Время ответа в миллисекундах, необходимо для разрешения состояния гонки

custom_attributesarray of objectrequired

Для профиля допускается задавать не более 30 пользовательских атрибутов

keystringrequired

valuestring | numberrequired

access_levelsarray of objectrequired

Массив объектов уровня доступа. Пустой массив, если у пользователя нет уровней доступа

access_level_idstring

Идентификатор уровня доступа

storestring

Стор, в котором был приобретён уровень доступа

store_product_idstring

Идентификатор продукта в сторе. Для годового тарифного плана App Store с обязательством идентификатор заканчивается на :monthly.

store_base_plan_idstring

Идентификатор базового тарифного плана в сторе

store_transaction_idstring

Идентификатор транзакции в сторе

store_original_transaction_idstring

Идентификатор оригинальной транзакции в сторе

offerallOf

Данные об офере, если был применён promotional offer или introductory offer

categorystring

Категория предложения

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

typestring

Тип предложения

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

idstring

Идентификатор предложения

starts_atstring

Когда начинается уровень доступа

purchased_atstring

Когда был приобретён уровень доступа

originally_purchased_atstring

Когда уровень доступа был приобретён впервые

expires_atstring

Когда истекает уровень доступа

renewal_cancelled_atstring

Когда было отменено продление

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли уровень доступа в льготном периоде

cancellation_reasonstring

Причина отмены

subscriptionsarray of objectrequired

Массив объектов подписки. Пустой массив, если у пользователя нет подписок

storestring

Стор, в котором была оформлена подписка

store_product_idstring

ID продукта в сторе. Для 12-месячного тарифного плана с обязательством в App Store ID заканчивается на :monthly.

store_base_plan_idstring

ID базового тарифного плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

Исходный ID транзакции в сторе

offerallOf

Детали офера, если был применён promotional offer или introductory offer

categorystring

Категория предложения

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

typestring

Тип предложения

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

idstring

Идентификатор предложения

environmentstring

Среда (Sandbox, Production)

purchased_atstring

Когда была оформлена подписка

originally_purchased_atstring

Когда подписка была оформлена впервые

expires_atstring

Когда истекает подписка

renewal_cancelled_atstring

Когда было отменено продление. Для 12-месячного тарифного плана с обязательством остаётся null после отмены подписчиком, поскольку ежемесячные платежи продолжаются. Используйте commitment.will_renew вместо этого.

billing_issue_detected_atstring

Когда была обнаружена проблема с оплатой

is_in_grace_periodboolean

Находится ли подписка в льготном периоде

cancellation_reasonstring

Причина отмены

commitmentallOf

12-месячное обязательство тарифного плана с обязательством App Store. Не задаётся для других подписок.

will_renewboolean

Начнётся ли новый 12-месячный период обязательств после окончания текущего. Принимает значение false после отмены подписки подписчиком, пока ежемесячные платежи продолжаются до expires_at.

billing_period_numberinteger

Номер текущего ежемесячного платежа в рамках периода обязательств, начиная с 1

total_billing_periodsinteger

Количество ежемесячных платежей в рамках периода обязательств

expires_atstring

Дата окончания периода обязательств. Собственное поле expires_at подписки соответствует концу текущего оплаченного месяца.

non_subscriptionsarray of objectrequired

Массив объектов разовых покупок. Пустой массив, если у пользователя нет покупок

purchase_idstring

Уникальный идентификатор покупки

storestring

Стор, в котором была совершена покупка

store_product_idstring

ID продукта в сторе

store_base_plan_idstring

ID базового плана в сторе

store_transaction_idstring

ID транзакции в сторе

store_original_transaction_idstring

Оригинальный ID транзакции в сторе

purchased_atstring

Дата и время совершения покупки

environmentstring

Среда (Sandbox, Production)

is_refundboolean

Является ли покупка возвратом средств

is_consumableboolean

Является ли покупка расходуемой

Некорректный запрос

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Не авторизован

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Профиль не найден

Schema

errorsarray of objectrequired

sourcestring

Источник ошибки

errorsarray of string

Массив сообщений об ошибках

error_codestringrequired

Краткое название ошибки

status_codeintegerrequired

HTTP-код статуса

Внутренняя ошибка сервера

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()