POST /api/v1/profile/save/

Profili kaydet

Adapty Mail'de bir profil oluşturur veya günceller. Profil, kullanıcının e-posta adresini ve Adapty Mail'in alıcıları tanımlamak ve segmentler oluşturmak için kullandığı nitelikleri taşır.

Her kullanıcıyı kalıcı bir external_profile_id ile tanımlayın. Aynı external_profile_id tekrar gönderildiğinde yeni bir kayıt oluşturmak yerine mevcut profil güncellenir.

Request body

external_profile_idstringrequired

Uygulamanıza veya arka ucunuza ait, kullanıcı için kalıcı tanımlayıcı. Adapty Mail'in e-postaları, tıklamaları ve satın almaları tek bir profile bağlayabilmesi için istekler arasında aynı değeri kullanın. Hiçbir zaman anonim veya kurulum başına bir tanımlayıcı kullanmayın.

external_created_atstringrequired

ISO 8601 biçiminde kullanıcı oluşturma zamanı (örneğin, "2026-06-01T10:30:00Z"). Bu tarihi segment'lerde kullanabilirsiniz.

emailstringrequired

Kullanıcının e-posta adresi. Adapty Mail kampanyaları bu adrese iletir. Adres yalnızca bir kez yazılabilir: profil oluşturulduğunda ayarlanır ve sonraki kayıtlar bu değerin üzerine yazamaz.

customer_user_idstring

Adapty'nin de bildiği bir tanımlayıcınız varsa, kullanıcının kendi sisteminizdeki tanımlayıcısı. Adapty Mail, Adapty SDK aracılığıyla da ulaşan bir kişiyi tanımak için bunu kullanır; böylece iki kaynak, aynı kişiye iki kez e-posta gönderecek bir kopya oluşturmak yerine tek bir profili paylaşır.

first_namestring

Kullanıcının adı.

last_namestring

Kullanıcının soyadı.

genderstring

Kullanıcının cinsiyeti.

birthdaystring

ISO 8601 biçiminde kullanıcının doğum tarihi (örneğin, "1990-05-21").

countrystring

İki harfli ISO 3166-1 alfa-2 kodu olarak kullanıcının ülkesi (örneğin, US).

store_countrystring

İki harfli ISO 3166-1 alfa-2 kodu olarak kullanıcının mağaza bölgesi (örneğin, US).

custom_attributesobject

Profile eklenecek rastgele anahtar-değer çiftleri (dize veya sayı değerleri). Bunları segment'ler oluşturmak için kullanın — örneğin, plan, signup_source veya trial_days.

device_infoobject

platformstringrequired

Kullanıcının kullandığı platform, örneğin iOS veya Android.

devicestring

Cihaz modeli, örneğin iPhone15,2.

osstring

İşletim sistemi sürümü, örneğin 17.5.

localestring

Kullanıcının yerel ayarı, örneğin en-US.

timezonestring

Kullanıcının saat dilimi, örneğin America/New_York.

app_versionstring

Kullanıcının çalıştırdığı uygulamanızın sürümü, örneğin 3.1.0.

Responses

Profil başarıyla kaydedildi. Yanıt gövdesi boş bir nesnedir.

Schema

object

Example

{}

Doğrulama başarısız — zorunlu bir alan eksik veya geçersiz. field_name hangi alanın hatalı olduğunu gösterir.

Schema

Standart hata yanıtı. Her başarısız istek bu yapıyla birlikte 4XX durumu döndürür.

errorsarray of object

messagestring

Hatanın insan tarafından okunabilir açıklaması.

error_codestring

Makine tarafından okunabilir hata tanımlayıcısı.

status_codeinteger

Bu hataya ait HTTP durum kodu.

field_namestring

Hataya neden olan istek alanı veya hata belirli bir alana özgü değilse null.

Example

{
  "errors": [
    {
      "message": "Field required",
      "error_code": "base_error",
      "status_code": 400,
      "field_name": "email"
    }
  ]
}

Gizli API anahtarı eksik veya geçersiz.

Schema

Standart hata yanıtı. Her başarısız istek bu yapıyla birlikte 4XX durumu döndürür.

errorsarray of object

messagestring

Hatanın insan tarafından okunabilir açıklaması.

error_codestring

Makine tarafından okunabilir hata tanımlayıcısı.

status_codeinteger

Bu hataya ait HTTP durum kodu.

field_namestring

Hataya neden olan istek alanı veya hata belirli bir alana özgü değilse null.

Example

{
  "errors": [
    {
      "message": "Secret key doesn't exist",
      "error_code": "secret_key_does_not_exist_error",
      "status_code": 403,
      "field_name": null
    }
  ]
}

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/save/' \
  --header 'Authorization: Bearer YOUR_ADAPTY_MAIL_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_profile_id": "user_12345",
    "external_created_at": "2026-06-01T10:30:00Z",
    "email": "jane@example.com",
    "country": "US",
    "custom_attributes": {
      "plan": "trial"
    }
  }'

const response = await fetch('https://api-mail.adapty.io/api/v1/profile/save/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ADAPTY_MAIL_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "external_profile_id": "user_12345",
    "external_created_at": "2026-06-01T10:30:00Z",
    "email": "jane@example.com",
    "country": "US",
    "custom_attributes": {
      "plan": "trial"
    }
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-mail.adapty.io/api/v1/profile/save/', headers={
    'Authorization': 'Bearer YOUR_ADAPTY_MAIL_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "external_profile_id": "user_12345",
      "external_created_at": "2026-06-01T10:30:00Z",
      "email": "jane@example.com",
      "country": "US",
      "custom_attributes": {
        "plan": "trial"
      }
    })
data = response.json()