POST /api/v2/server-side-api/profile/

Crear perfil

Crea un nuevo usuario final de tu aplicación en Adapty.

Header parameters

adapty-customer-user-idstring

El ID único del cliente en tu sistema. Se requiere adapty-customer-user-id o adapty-profile-id.

adapty-profile-idstring

El ID único del perfil en tu sistema. Es la mejor opción si trabajas con perfiles anónimos. Se requiere adapty-customer-user-id o adapty-profile-id.

adapty-platformstring

La plataforma del dispositivo donde el usuario tiene instalada tu aplicación

Request body

first_namestring

Nombre de tu usuario final

last_namestring

Apellido de tu usuario final

genderstring

Género de tu usuario final

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

emailstring

Correo electrónico de tu usuario final

phone_numberstring

Número de teléfono de tu usuario final

birthdaystring

Fecha de nacimiento de tu usuario final

ip_countrystring

País del usuario final como código ISO 3166-1 alpha-2 de dos letras, por ejemplo FR

ip_v4_addressstring

Dirección IPv4 del usuario final

store_countrystring

País del store del usuario final como código ISO 3166-1 alpha-2 de dos letras, por ejemplo US

storestring

La plataforma que usa el usuario para realizar compras in-app en tu aplicación

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

store_account_tokenstring

Token de cuenta del store

att_statusinteger

Estado de Apple App Tracking Transparency (0=no determinado, 1=restringido, 2=denegado, 3=autorizado)

One of: 0, 1, 2, 3

analytics_disabledboolean

Opción para excluirse de la analítica externa

custom_attributesarray of object

Permite configurar hasta 30 atributos personalizados para el perfil

keystringrequired

La clave debe ser una cadena de no más de 30 caracteres. Solo se permiten letras, números, guiones, puntos y guiones bajos

valuestring | numberrequired

El valor del atributo no debe superar los 50 caracteres. Solo se permiten cadenas y números en coma flotante como valores

installation_metaobjectrequired

device_idstringrequired

Identificador único del dispositivo

devicestring

Información del dispositivo

localestring

Configuración regional del dispositivo

osstring

Información del sistema operativo

platformstring

Plataforma (iOS, Android, etc.)

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

timezonestring

Zona horaria del dispositivo

user_agentstring

Cadena de agente de usuario

app_buildstring

Versión de compilación de la aplicación

app_versionstring

Versión de la aplicación

adapty_sdk_versionstring

Versión del SDK de Adapty

idfastring

Identificador para anunciantes de iOS

idfvstring

Identificador para proveedores de iOS

advertising_idstring

ID de publicidad de Android

android_idstring

ID de dispositivo Android

android_app_set_idstring

ID de conjunto de aplicaciones de Android

Responses

Perfil creado correctamente

Schema

dataobjectrequired

app_idstringrequired

El ID interno de tu aplicación

profile_idstringrequired

ID de perfil de Adapty

customer_user_idstringrequired

El ID de tu usuario en tu sistema

total_revenue_usdnumberrequired

Un valor de tipo float que representa los ingresos totales en USD obtenidos en el perfil

segment_hashstringrequired

Parámetro interno

timestampintegerrequired

Tiempo de respuesta en milisegundos, necesario para resolver una condición de carrera

custom_attributesarray of objectrequired

Se permite establecer un máximo de 30 atributos personalizados en el perfil

keystringrequired

La clave debe ser una cadena de no más de 30 caracteres. Solo se permiten letras, números, guiones, puntos y guiones bajos

valuestring | numberrequired

El valor del atributo no debe superar los 50 caracteres. Solo se permiten cadenas y números en coma flotante como valores

access_levelsarray of objectrequired

Array de objetos de nivel de acceso. Array vacío si el cliente no tiene niveles de acceso

access_level_idstring

Identificador del nivel de acceso

storestring

Store donde se adquirió el nivel de acceso

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

offerallOf

Detalles de la oferta, si se aplicó una oferta promocional o introductoria

categorystring

Categoría de la oferta

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

typestring

Tipo de oferta

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

idstring

ID de la oferta

starts_atstring

Cuándo comienza el nivel de acceso

purchased_atstring

Cuándo se adquirió el nivel de acceso

originally_purchased_atstring

Cuándo se adquirió el nivel de acceso originalmente

expires_atstring

Cuándo expira el nivel de acceso

renewal_cancelled_atstring

Cuándo se canceló la renovación

billing_issue_detected_atstring

Cuándo se detectó el problema de facturación

is_in_grace_periodboolean

Si el nivel de acceso está en período de gracia

cancellation_reasonstring

Motivo de la cancelación

subscriptionsarray of objectrequired

Array de objetos de suscripción. Array vacío si el cliente no tiene suscripciones

storestring

Store donde se realizó la compra de la suscripción

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

offerallOf

Detalles de la oferta, si se aplicó una oferta promocional o introductoria

categorystring

Categoría de la oferta

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

typestring

Tipo de oferta

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

idstring

ID de la oferta

environmentstring

Entorno (Sandbox, Production)

purchased_atstring

Fecha en que se compró la suscripción

originally_purchased_atstring

Fecha en que se compró originalmente la suscripción

expires_atstring

Fecha en que expira la suscripción

renewal_cancelled_atstring

Fecha en que se canceló la renovación

billing_issue_detected_atstring

Fecha en que se detectó un problema de facturación

is_in_grace_periodboolean

Si la suscripción está en período de gracia

cancellation_reasonstring

Motivo de la cancelación

non_subscriptionsarray of objectrequired

Array de objetos de compra única. Array vacío si el cliente no tiene compras

purchase_idstring

Identificador único de la compra

storestring

Store donde se realizó la compra

store_product_idstring

ID del producto en el store

store_base_plan_idstring

ID del plan base en el store

store_transaction_idstring

ID de la transacción en el store

store_original_transaction_idstring

ID de la transacción original en el store

purchased_atstring

Fecha y hora en que se realizó la compra

environmentstring

Entorno (Sandbox, Production)

is_refundboolean

Indica si se trata de un reembolso

is_consumableboolean

Indica si se trata de una compra consumible

Example

{
  "data": {
    "app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
    "customer_user_id": "jane.doe@example.com",
    "total_revenue_usd": 0,
    "segment_hash": "8f45947bad31ab0c",
    "timestamp": 1736425645861,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [],
    "subscriptions": [],
    "non_subscriptions": []
  }
}

No autorizado

Schema

errorsarray of objectrequired

sourcestring

Fuente del error

errorsarray of string

Array de mensajes de error

error_codestringrequired

Nombre corto del error

status_codeintegerrequired

Código de estado HTTP

Example

{
  "errors": [
    {
      "source": "non_field_errors",
      "errors": [
        "Authentication credentials were not provided."
      ]
    }
  ],
  "error_code": "not_authenticated",
  "status_code": 401
}

Error interno del servidor

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

adapty-platform

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/profile/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Jane",
    "last_name": "Doe",
    "gender": "f",
    "email": "jane.doe@example.com",
    "phone_number": "+1234567890",
    "birthday": "2000-12-31",
    "ip_country": "FR",
    "store_country": "US",
    "store": "app_store",
    "analytics_disabled": true,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "installation_meta": {
      "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "device": "string",
      "locale": "en",
      "os": "string",
      "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",
      "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
      "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
      "advertising_id": "",
      "android_id": "",
      "android_app_set_id": ""
    }
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/profile/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "first_name": "Jane",
    "last_name": "Doe",
    "gender": "f",
    "email": "jane.doe@example.com",
    "phone_number": "+1234567890",
    "birthday": "2000-12-31",
    "ip_country": "FR",
    "store_country": "US",
    "store": "app_store",
    "analytics_disabled": true,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "installation_meta": {
      "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "device": "string",
      "locale": "en",
      "os": "string",
      "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",
      "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
      "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
      "advertising_id": "",
      "android_id": "",
      "android_app_set_id": ""
    }
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/profile/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "first_name": "Jane",
      "last_name": "Doe",
      "gender": "f",
      "email": "jane.doe@example.com",
      "phone_number": "+1234567890",
      "birthday": "2000-12-31",
      "ip_country": "FR",
      "store_country": "US",
      "store": "app_store",
      "analytics_disabled": True,
      "custom_attributes": [
        {
          "key": "favourite_sport",
          "value": "yoga"
        }
      ],
      "installation_meta": {
        "device_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "device": "string",
        "locale": "en",
        "os": "string",
        "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",
        "idfa": "EA7583CD-A667-48BC-B806-42ECB2B48333",
        "idfv": "E9D48DA5-3930-4B41-8521-D953AECD2F33",
        "advertising_id": "",
        "android_id": "",
        "android_app_set_id": ""
      }
    })
data = response.json()