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

Créer un profil

Crée un nouvel utilisateur final de votre application dans Adapty.

Header parameters

adapty-customer-user-idstring

L'identifiant unique du client dans votre système. adapty-customer-user-id ou adapty-profile-id est requis.

adapty-profile-idstring

L'identifiant unique du profil dans votre système. Meilleure option si vous travaillez avec des profils anonymes. adapty-customer-user-id ou adapty-profile-id est requis.

adapty-platformstring

La plateforme de l'appareil sur lequel l'utilisateur a installé votre application

Request body

first_namestring

Prénom de votre utilisateur final

last_namestring

Nom de famille de votre utilisateur final

genderstring

Genre de votre utilisateur final

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

emailstring

Adresse e-mail de votre utilisateur final

phone_numberstring

Numéro de téléphone de votre utilisateur final

birthdaystring

Date de naissance de votre utilisateur final

ip_countrystring

Pays de l'utilisateur final au format ISO 3166-2

ip_v4_addressstring

Adresse IPv4 de l'utilisateur final

store_countrystring

Pays du store de l'utilisateur final

storestring

La plateforme utilisée par l'utilisateur pour effectuer des achats dans votre application

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

store_account_tokenstring

Jeton de compte du store

att_statusinteger

Statut Apple App Tracking Transparency (0=non déterminé, 1=restreint, 2=refusé, 3=autorisé)

One of: 0, 1, 2, 3

analytics_disabledboolean

Option pour se désinscrire des analyses externes

custom_attributesarray of object

Permet de définir jusqu'à 30 attributs personnalisés pour le profil

keystringrequired

La clé doit être une chaîne de caractères d'au plus 30 caractères. Seuls les lettres, chiffres, tirets, points et underscores sont autorisés

valuestring | numberrequired

La valeur de l'attribut doit comporter au plus 50 caractères. Seules les chaînes de caractères et les décimaux sont autorisés comme valeurs

installation_metaobjectrequired

device_idstringrequired

Identifiant unique de l'appareil

devicestring

Informations sur l'appareil

localestring

Langue de l'appareil

osstring

Informations sur le système d'exploitation

platformstring

Plateforme (iOS, Android, etc.)

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

timezonestring

Fuseau horaire de l'appareil

user_agentstring

Chaîne user agent

app_buildstring

Version de build de l'application

app_versionstring

Version de l'application

adapty_sdk_versionstring

Version du SDK Adapty

idfastring

Identifiant iOS pour les annonceurs

idfvstring

Identifiant iOS pour les éditeurs

advertising_idstring

Identifiant publicitaire Android

android_idstring

Identifiant de l'appareil Android

android_app_set_idstring

Identifiant d'ensemble d'applications Android

Responses

Profil créé avec succès

Schema

dataobjectrequired

app_idstringrequired

L'identifiant interne de votre application

profile_idstringrequired

Identifiant de profil Adapty

customer_user_idstringrequired

L'identifiant de votre utilisateur dans votre système

total_revenue_usdnumberrequired

Valeur décimale représentant le chiffre d'affaires total en USD généré par le profil

segment_hashstringrequired

Paramètre interne

timestampintegerrequired

Temps de réponse en millisecondes, nécessaire pour résoudre une condition de concurrence

custom_attributesarray of objectrequired

Maximum de 30 attributs personnalisés autorisés pour le profil

keystringrequired

La clé doit être une chaîne de caractères d'au plus 30 caractères. Seuls les lettres, chiffres, tirets, points et underscores sont autorisés

valuestring | numberrequired

La valeur de l'attribut doit comporter au plus 50 caractères. Seules les chaînes de caractères et les décimaux sont autorisés comme valeurs

access_levelsarray of objectrequired

Tableau d'objets de niveau d'accès. Tableau vide si le client n'a aucun niveau d'accès

access_level_idstring

Identifiant du niveau d'accès

storestring

Store où le niveau d'accès a été acheté

store_product_idstring

Identifiant du produit dans le store

store_base_plan_idstring

Identifiant du plan de base dans le store

store_transaction_idstring

Identifiant de transaction dans le store

store_original_transaction_idstring

Identifiant de transaction originale dans le store

offerallOf

Détails de l'offre, si une offre promotionnelle ou de lancement a été appliquée

categorystring

Catégorie de l'offre

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

typestring

Type d'offre

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

idstring

Identifiant de l'offre

starts_atstring

Quand le niveau d'accès commence

purchased_atstring

Quand le niveau d'accès a été acheté

originally_purchased_atstring

Quand le niveau d'accès a été acheté initialement

expires_atstring

Quand le niveau d'accès expire

renewal_cancelled_atstring

Quand le renouvellement a été annulé

billing_issue_detected_atstring

Quand un problème de facturation a été détecté

is_in_grace_periodboolean

Si le niveau d'accès est en délai de grâce

cancellation_reasonstring

Raison de l'annulation

subscriptionsarray of objectrequired

Tableau d'objets d'abonnement. Tableau vide si le client n'a aucun abonnement

storestring

Store où l'abonnement a été acheté

store_product_idstring

Identifiant du produit dans le store

store_base_plan_idstring

Identifiant du plan de base dans le store

store_transaction_idstring

Identifiant de transaction dans le store

store_original_transaction_idstring

Identifiant de transaction originale dans le store

offerallOf

Détails de l'offre, si une offre promotionnelle ou de lancement a été appliquée

categorystring

Catégorie de l'offre

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

typestring

Type d'offre

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

idstring

Identifiant de l'offre

environmentstring

Environnement (Sandbox, Production)

purchased_atstring

Quand l'abonnement a été acheté

originally_purchased_atstring

Quand l'abonnement a été acheté initialement

expires_atstring

Quand l'abonnement expire

renewal_cancelled_atstring

Quand le renouvellement a été annulé

billing_issue_detected_atstring

Quand un problème de facturation a été détecté

is_in_grace_periodboolean

Si l'abonnement est en délai de grâce

cancellation_reasonstring

Raison de l'annulation

non_subscriptionsarray of objectrequired

Tableau d'objets hors abonnement. Tableau vide si le client n'a aucun achat

purchase_idstring

Identifiant unique de l'achat

storestring

Store où l'achat a été effectué

store_product_idstring

Identifiant du produit dans le store

store_base_plan_idstring

Identifiant du plan de base dans le store

store_transaction_idstring

Identifiant de transaction dans le store

store_original_transaction_idstring

Identifiant de transaction originale dans le store

purchased_atstring

Quand l'achat a été effectué

environmentstring

Environnement (Sandbox, Production)

is_refundboolean

Si cet achat est un remboursement

is_consumableboolean

Si cet achat est un consommable

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": []
  }
}

Non autorisé

Schema

errorsarray of objectrequired

sourcestring

Source de l'erreur

errorsarray of string

Tableau de messages d'erreur

error_codestringrequired

Nom court de l'erreur

status_codeintegerrequired

Code de statut HTTP

Example

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

Erreur interne du serveur

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