Enviar emails y transacciones a través de la API de Adapty Mail

La API de Adapty Mail te permite enviar perfiles de usuario y transacciones a Adapty Mail directamente desde tu servidor, sin enrutar los datos a través del SDK de Adapty. Úsala cuando quieras:

  • Agrega suscriptores cuando aún no tienes una base en Adapty Mail.
  • Reutiliza la base de suscriptores de tus otras apps.
  • Alimenta Adapty Mail de servidor a servidor, con tu backend como fuente de verdad.
Note

¿API o SDK? La mayoría de las apps envían datos a Adapty Mail a través del SDK de Adapty, que recopila emails y compras automáticamente — consulta Conectar Adapty con Adapty Mail. Usa la API cuando tu app no tenga el SDK de Adapty, cuando los datos ya estén en tu servidor, o cuando importes suscriptores desde otra fuente. También puedes usar la API junto con otro punto de entrada. Adapty Mail identifica a las personas por dirección de email. Si dos fuentes reportan la misma dirección, se asocian a un único perfil; si las direcciones son distintas, se crean perfiles separados, aunque el customer_user_id sea idéntico.

Antes de empezar

Warning

Termina de configurar Adapty Mail antes de enviar datos: necesitas una campaña, segmentos (si los necesitas), un paywall web y un flow lanzado. Adapty Mail solo envía correos a los perfiles creados después de completar esta configuración; los perfiles que envíes antes no recibirán ningún correo. Sigue primero Primeros pasos con Adapty Mail y luego vuelve aquí.

También necesitas tu clave API y la URL base:

  • Clave de API secreta: En Adapty Mail, ve a Settings > Project y copia la Secret key. La clave es específica del proyecto, de modo que la API sabe a qué proyecto pertenecen los datos.
  • URL base: Todas las solicitudes van a https://api-mail.adapty.io.
  • Autenticación: Envía la clave en el encabezado Authorization como Bearer {your_secret_api_key}.
Important

Obtén el consentimiento explícito antes de recopilar correos electrónicos y enviarlos a Adapty Mail. Eres responsable del cumplimiento del RGPD, CAN-SPAM y normativas similares aplicables en tus mercados.

Enviar perfiles de usuario

Un perfil contiene el email y los atributos del usuario. Para crear o actualizar uno, envía una solicitud POST a /api/v1/profile/save/.

Se requieren tres campos:

  • Un external_profile_id estable que tu app o backend gestione
  • El email al que Adapty Mail envía las campañas
  • external_created_at — la fecha de creación del usuario, que puedes usar en segmentos
Important

Envía siempre un external_profile_id estable, nunca un valor anónimo o por instalación. Adapty Mail lo usa para vincular emails, clics y compras a un único perfil.

Si la misma persona también llega a Adapty Mail a través de otro punto de entrada, envía customer_user_id — el mismo ID de usuario que utiliza la fuente. En el SDK de Adapty es el valor que pasas a Adapty.identify(); FunnelFox envía el que tiene almacenado. Esto no determina en qué perfil aterriza el usuario; eso lo decide la dirección de email. Lo que aporta es una segunda forma de encontrar el perfil: un evento de transacción que lo incluya se resuelve sin necesidad de email, y una eliminación puede identificarlo por este valor en lugar de por la dirección.

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/save/' \
  --header 'Authorization: Bearer {your_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"
    }
  }'
Note

country y store_country usan un código de dos letras según la norma ISO 3166-1 alpha-2 — US, no USA ni United States. Cualquier otro valor se rechaza.

device_info describe el dispositivo del usuario. El objeto es opcional, pero platform debe estar presente siempre que lo envíes.

CampoOpcionalFiltro de segmentoNotas
platformNoSí
deviceSíSíEl modelo del dispositivo.
osSíSí
localeSíSí
app_versionSíSíSe compara por orden de versión, por lo que 1.10.0 está por encima de 1.9.0.
timezoneSíNoDefine cuándo recibe el usuario los correos. Sin este campo, Adapty Mail lo trata como UTC, por lo que la ventana de envío de 08:00–21:00 sigue UTC en lugar de la hora local del usuario.

Consulta la referencia de Save profile para ver todos los campos disponibles.

Enviar eventos de transacción

Note

Con un perfil que tenga email es suficiente para llegar a los usuarios en el flow de nunca han comprado. Los usuarios en cualquier otro flow también necesitan eventos de transacción.

Todos los flows excepto el de nunca han comprado se basan en el historial de compras. Envía los eventos de transacción de un perfil a medida que gestiones compras, renovaciones y cancelaciones, para que Adapty Mail pueda ubicarlo en el flow correcto. Los eventos de transacción también alimentan la atribución de ingresos. Omítelos solo si ejecutas campañas exclusivamente de nunca han comprado.

Para registrar una transacción, envía una petición POST a /api/v1/profile/transaction-event/save/. Usa el mismo external_profile_id que enviaste con el perfil para que Adapty Mail vincule la transacción al usuario correcto.

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/transaction-event/save/' \
  --header 'Authorization: Bearer {your_secret_api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "event_type": "subscription_started",
    "event_id": "evt_abc123",
    "event_datetime": "2026-06-10T14:20:05Z",
    "external_profile_id": "user_12345",
    "store": "app_store",
    "store_product_id": "premium_monthly",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "purchased_at": "2026-06-10T14:20:00Z",
    "originally_purchased_at": "2026-06-10T14:20:00Z",
    "price_usd": "9.99"
  }'

See the Save transaction event reference for every available field.

You can send a transaction before the profile exists. Adapty Mail keeps the event unattached, then links it to the profile on the next save that includes the same external_profile_id.

Eliminar un perfil

Para atender una solicitud de derecho al olvido, envía los identificadores del perfil a /api/v1/profile/delete/. Adapty Mail borra los datos personales del perfil y cancela sus correos programados.

curl --request POST \
  --url 'https://api-mail.adapty.io/api/v1/profile/delete/' \
  --header 'Authorization: Bearer {your_secret_api_key}' \
  --header 'Content-Type: application/json' \
  --data '{
    "external_profile_id": "user_12345"
  }'

Identifica el perfil mediante external_profile_id, customer_user_id o email — envía al menos uno. Adapty Mail borra los datos almacenados, pero no bloquea la dirección: si una fuente la vuelve a enviar, aparece un nuevo perfil sin historial. Para excluir a alguien de forma permanente, impide que la fuente envíe sus datos.

Una solicitud de eliminación que agota el tiempo de espera te deja sin saber si llegó a procesarse, así que la reenvías. Esa segunda llamada es segura cuando identificas el perfil por external_profile_id o customer_user_id — tiene éxito y no cambia nada. Una segunda llamada que lleva solo email devuelve 404, porque la primera eliminación borró la dirección con la que habría coincidido. La referencia de Eliminar perfil lista los códigos de respuesta.

Asigna tus eventos a los flows

Envía el event_type que corresponda a lo que ocurrió. Adapty Mail deduce el estado del perfil a partir del historial de eventos y lo enruta al flow correspondiente.

event_typeEnvíalo cuandoFlow
subscription_startedUn usuario inicia una nueva suscripción.Activo — sin flow de reenganche
subscription_renewedUna suscripción se renueva automáticamente.Activo — sin flow de reenganche
subscription_renewal_reactivatedUn usuario reactiva la renovación automática.Activo — sin flow de reenganche
non_subscription_purchaseUn usuario realiza una compra única.Activo — sin flow de reenganche
subscription_renewal_cancelledUn usuario desactiva la renovación automática (sigue activa hasta que expire).Renovación cancelada
billing_issue_detectedFalla el pago de una renovación.Problema de facturación
entered_grace_periodEl pago falla pero el usuario sigue en el período de gracia.Problema de facturación
subscription_expiredUna suscripción caduca y se pierde el acceso.Expirada
subscription_refundedSe reembolsa una compra de suscripción.Reembolsada
non_subscription_purchase_refundedSe reembolsa una compra única.Reembolsada