# OneSignal: Spanish > OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard. ## Spanish - [Spanish / Guías del Usuario (178 pages)](https://documentation.onesignal.com/_llms/es/guias-del-usuario.md): Documentation for Spanish / Guías del Usuario. ### Inicio - [Documentación de OneSignal](https://documentation.onesignal.com/docs/es/home.md): Comienza a construir más rápido con OneSignal. Explora guías rápidas, SDKs, canales de mensajería, referencias API y funciones avanzadas como Journeys y Live Activities. ### Guías del desarrollador #### Documentación del desarrollador - [Desarrolladores](https://documentation.onesignal.com/docs/es/developers.md): Configura los SDK móvil y web de OneSignal, encuentra tu App ID y claves API, identifica Usuarios y prueba tu integración antes de lanzar. - [Verificación de identidad](https://documentation.onesignal.com/docs/es/identity-verification.md): Previene la suplantación de usuarios requiriendo JWTs generados en el servidor para verificar IDs de Usuario Externos, correos electrónicos y suscripciones de SMS enviados a OneSignal. ##### Modelo de usuario - [Modelo de usuario y guía de migración](https://documentation.onesignal.com/docs/es/user-model-migration-guide.md): Aprende cómo migrar del modelo centrado en dispositivos de OneSignal a las nuevas APIs y SDKs centrados en usuario para compromiso multi-canal más personalizado. - [Mapeo de SDK móvil](https://documentation.onesignal.com/docs/es/device-user-model-mobile-sdk-mapping.md): Compare nombres de métodos y propiedades entre el Modelo de Jugador heredado de OneSignal (v3 y v4) y el Modelo de Usuario moderno (v5+), con ejemplos de código Swift lado a lado para una migración más fácil. - [Mapeo de SDK web](https://documentation.onesignal.com/docs/es/device-user-model-web-sdk-mapping.md): Compare métodos del SDK web de OneSignal entre el Modelo de Jugador heredado y el nuevo Modelo de Usuario. Aprenda cómo migrar su implementación con ejemplos de código basados en TypeScript y referencias de métodos actualizadas. #### SDKs móviles ##### Configuración del SDK móvil - [Configuración del SDK móvil](https://documentation.onesignal.com/docs/es/mobile-sdk-setup.md): Configura el SDK de OneSignal para Android, iOS, Huawei, Amazon y frameworks multiplataforma como React Native, Expo, Flutter, Unity, Cordova y Capacitor. - [Configuración del SDK de iOS](https://documentation.onesignal.com/docs/es/ios-sdk-setup.md): Agrega notificaciones push y mensajes dentro de la aplicación a tu app de iOS con el SDK de OneSignal: integración en Xcode, APNs y prueba en dispositivo. - [Configuración del SDK de Android](https://documentation.onesignal.com/docs/es/android-sdk-setup.md): Instale el SDK de Android de OneSignal en Android Studio para agregar push y mensajes in-app, con credenciales FCM, inicialización y pruebas. - [Configuración Unity SDK](https://documentation.onesignal.com/docs/es/unity-sdk-setup.md): Integra el Unity SDK de OneSignal para agregar notificaciones push a tus apps Unity en iOS, Android, Amazon y Huawei, desde instalación a inicialización. - [Configuración del SDK React Native](https://documentation.onesignal.com/docs/es/react-native-sdk-setup.md): Guía completa para integrar el SDK React Native de OneSignal para plataformas de apps iOS, Android y Amazon. Incluye prerequisitos, pasos de configuración, configuración específica de plataforma y solución de problemas comunes. - [Configuración del SDK Expo](https://documentation.onesignal.com/docs/es/react-native-expo-sdk-setup.md): Integra el SDK Expo de OneSignal en tus apps iOS y Android usando Expo SDK 53+ y EAS Build para notificaciones push y mensajes in-app. - [Configuración del SDK de Flutter](https://documentation.onesignal.com/docs/es/flutter-sdk-setup.md): Instrucciones para agregar el SDK de Flutter de OneSignal a tu aplicación Flutter para iOS y Android - [Configuración del SDK de Flutterflow](https://documentation.onesignal.com/docs/es/flutterflow-sdk-setup.md): Instrucciones para agregar el SDK de Flutter de OneSignal a tu aplicación Flutterflow para iOS y Android - [Configuración del SDK de Cordova](https://documentation.onesignal.com/docs/es/cordova-sdk-setup.md): Configura el SDK de Cordova de OneSignal para agregar notificaciones push a aplicaciones Cordova e Ionic Cordova en iOS y Android. - [Configuración del SDK para Capacitor](https://documentation.onesignal.com/docs/es/capacitor-sdk-setup.md): Configura el SDK de OneSignal para Capacitor para agregar notificaciones push a aplicaciones Capacitor en iOS y Android. - [Configuración del SDK .NET MAUI](https://documentation.onesignal.com/docs/es/net-sdk-setup.md): Instrucciones para agregar el SDK .NET de OneSignal a tu app MAUI multiplataforma para iOS, Android y escritorio. - [Configuración del SDK de Amazon](https://documentation.onesignal.com/docs/es/amazon-sdk-setup.md): Guía paso a paso para integrar el SDK de OneSignal en su aplicación de Amazon Fire OS para capacidades de notificaciones push y mensajería en la aplicación. - [Configuración del SDK de Huawei](https://documentation.onesignal.com/docs/es/huawei-sdk-setup.md): Guía de Configuración del SDK de Huawei de OneSignal para Android Studio. ###### Configuración de credenciales de plataforma - [Credenciales de Android Firebase](https://documentation.onesignal.com/docs/es/android-firebase-credentials.md): Configure las credenciales de Service Account de Firebase Cloud Messaging (FCM) en OneSignal para habilitar notificaciones push de Android en aplicaciones de Google Play Store. - [Conexión basada en token p8 de iOS a APNs](https://documentation.onesignal.com/docs/es/ios-p8-token-based-connection-to-apns.md): Configura una clave de autenticación .p8 para conectar tu app iOS o macOS a Apple Push Notification service (APNs) a través de OneSignal. - [Generación de certificado p12 para iOS](https://documentation.onesignal.com/docs/es/ios-p12-generate-certificates.md): Genera y carga un certificado push .p12 para conectar tu aplicación iOS o macOS al servicio de notificaciones push de Apple (APNs) a través de OneSignal. - [Generación de clave API de Amazon](https://documentation.onesignal.com/docs/es/generate-an-amazon-api-key.md): Guía paso a paso - [Autorización de Huawei](https://documentation.onesignal.com/docs/es/authorize-onesignal-to-send-huawei-push.md): Guía paso a paso para conectar su aplicación de Huawei a OneSignal para notificaciones push, incluida la configuración de PushKit, configuración de claves API y la autoclasificación de mensajes opcional de Huawei para aplicaciones con usuarios en China. ##### Referencia del SDK móvil - [Referencia del SDK móvil](https://documentation.onesignal.com/docs/es/mobile-sdk-reference.md): Referencia de la API del SDK móvil de OneSignal: inicialización, identidad de usuario, suscripciones, etiquetas, permisos y mensajes in-app. - [Extensiones de servicio móvil](https://documentation.onesignal.com/docs/es/service-extensions.md): Intercepta y personaliza notificaciones push antes de mostrarlas en iOS y Android: medios enriquecidos, entrega confirmada y datos en segundo plano. - [Gestión de la bandeja de notificaciones](https://documentation.onesignal.com/docs/es/managing-the-notification-tray.md): Cómo se comportan las notificaciones push móviles de OneSignal en la bandeja de notificaciones en Android e iOS: manejo de clics y descartes, notificaciones restauradas, insignias, borrado de notificaciones programáticamente y extensiones de servicio. - [Payload OSNotification](https://documentation.onesignal.com/docs/es/osnotification-payload.md): Referencia del objeto OSNotification de OneSignal, incluyendo todos los campos del payload, propiedades específicas de Android e iOS, datos personalizados y acciones de clic. - [iOS: Soporte de App Clip](https://documentation.onesignal.com/docs/es/app-clip-support.md): Aprenda cómo habilitar y configurar notificaciones push de OneSignal en App Clips de iOS. Cubre pasos de configuración, limitaciones y soporte para experiencias avanzadas como Target-Content-ID. ##### Solución de problemas del SDK móvil - [Solución de problemas del SDK móvil](https://documentation.onesignal.com/docs/es/mobile-troubleshooting.md): Resuelve problemas comunes del SDK móvil de OneSignal, incluidos fallos en la entrega push, errores de APNS y problemas de mensajería en la app para iOS, Android y frameworks cross-platform. - [Obtener un registro de depuración](https://documentation.onesignal.com/docs/es/capturing-a-debug-log.md): Aprenda cómo capturar registros de depuración detallados de su aplicación móvil usando el SDK de OneSignal. Esta guía explica cómo habilitar el registro detallado, reproducir problemas y compartir registros para solucionar problemas de notificaciones push en plataformas Android e iOS. #### SDKs web - [Referencia del Web SDK](https://documentation.onesignal.com/docs/es/web-sdk-reference.md): Referencia de la API del Web SDK v16 de OneSignal: inicialización, login, propiedades de usuario, suscripciones push, prompts slidedown y eventos. ##### Configuración del SDK web - [Configuración SDK Web](https://documentation.onesignal.com/docs/es/web-sdk-setup.md): Agrega notificaciones web push de OneSignal a tu sitio web con el SDK de JavaScript, configuración de service worker y configuración del dashboard. - [Configuración web push para iOS](https://documentation.onesignal.com/docs/es/web-push-for-ios.md): Guía completa para habilitar notificaciones web push en dispositivos iOS e iPadOS, incluyendo configuración de archivo manifest, estrategias de incorporación de usuarios y mejores prácticas de implementación para navegadores Safari, Chrome y Edge. - [OneSignal service worker](https://documentation.onesignal.com/docs/es/onesignal-service-worker.md): Configura el archivo OneSignalSDKWorker.js para que tu sitio web pueda recibir y mostrar notificaciones web push a través de OneSignal. - [Configuración de push web con código personalizado](https://documentation.onesignal.com/docs/es/web-push-custom-code-setup.md): Añade notificaciones push web con código personalizado: agrega el SDK de JavaScript de OneSignal, el service worker e inicializa en tu sitio. - [Configuración de Google Tag Manager](https://documentation.onesignal.com/docs/es/google-tag-manager.md): Añade OneSignal Web Push a tu sitio web usando Google Tag Manager (GTM), incluyendo la configuración del service worker, inicialización y configuración segura de etiquetas. - [Configuración del SDK web de Angular](https://documentation.onesignal.com/docs/es/angular-setup.md): Integre notificaciones push web de OneSignal en su aplicación Angular usando el paquete onesignal-ngx. Aprenda cómo instalar, configurar y solucionar problemas de service workers para entregar notificaciones push sin problemas. - [Configuración de ReactJS y NextJS](https://documentation.onesignal.com/docs/es/react-js-setup.md): Aprende cómo integrar notificaciones push de OneSignal con tu aplicación web ReactJS o NextJS, incluyendo inicialización, configuración de service worker y soporte TypeScript. - [Configuración SDK Web Vue JS](https://documentation.onesignal.com/docs/es/vue-js-setup.md): Integra Notificaciones Web Push de OneSignal en tu aplicación Vue.js usando el plugin onesignal-vue o @onesignal/onesignal-vue3. Aprende a instalar, configurar y personalizar service workers para una entrega push perfecta. ##### Solución de problemas del SDK web - [Solución de problemas del Web SDK](https://documentation.onesignal.com/docs/es/troubleshooting-web-push.md): Soluciona problemas de OneSignal Web Push incluyendo errores de service worker, desajustes de origen, tipos MIME y notificaciones que no se muestran. - [Limpiar caché y restablecer permisos de push](https://documentation.onesignal.com/docs/es/clearing-cache-and-resetting-push-permissions.md): Aprenda cómo restablecer los permisos de push del navegador, service workers y datos del sitio en Chrome, Firefox y Safari para garantizar entornos de prueba limpios y resolver problemas de notificaciones push web. - [Webhooks web push](https://documentation.onesignal.com/docs/es/webhooks.md): Configura webhooks HTTP para recibir notificaciones en tiempo real cuando los usuarios muestran, hacen clic o descartan notificaciones web push. Guía completa con ejemplos para soporte de navegadores Chrome, Firefox y Safari. #### Actividades en directo - [Configuración de Live Activities para desarrolladores](https://documentation.onesignal.com/docs/es/live-activities-developer-setup.md): Configura Live Activities de iOS con OneSignal para mostrar actualizaciones en tiempo real en la pantalla de bloqueo y Dynamic Island. - [Configuración del SDK de Live Activity multiplataforma](https://documentation.onesignal.com/docs/es/cross-platform-live-activity-setup.md): Agregue Live Activities a apps React Native, Flutter, Unity, Cordova o .NET MAUI. Con setupDefault, OneSignal gestiona el ciclo de vida de ActivityKit. - [Notificaciones Live Update de Android](https://documentation.onesignal.com/docs/es/android-live-notifications.md): Cree Live Updates de Android con push de OneSignal: un payload estructurado actualiza una notificación persistente vía una Notification Service Extension. #### Configuración de Desktop & Watch - [Configuración de app macOS](https://documentation.onesignal.com/docs/es/macos-app-setup.md): Aprende a integrar OneSignal en tu app de macOS, ya sea usando Mac Catalyst o acceso directo a la API. Guía paso a paso para configurar plataformas, instalar el SDK y enviar notificaciones push. - [Configuración app Windows](https://documentation.onesignal.com/docs/es/windows-app-setup.md): Guía completa para integrar notificaciones push de OneSignal en tu app Universal Windows Platform (UWP) usando Windows Push Notification Service (WNS) y la API REST de OneSignal - [Soporte watchOS y Wear OS](https://documentation.onesignal.com/docs/es/watchos-and-wear-os-support.md): Guía completa para implementar notificaciones push de OneSignal para aplicaciones independientes de Apple watchOS y Android Wear OS, incluyendo instrucciones de configuración e integración de API. ### Tutoriales #### Tutoriales - [Tutoriales y casos de uso](https://documentation.onesignal.com/docs/es/tutorials.md): Explora tutoriales paso a paso y ejemplos de mejores prácticas para ayudarte a implementar características de OneSignal y aumentar el compromiso, retención e ingresos. #### 🏢 Por Industria - [Estrategias de gaming](https://documentation.onesignal.com/docs/es/gaming-industry.md): Guía de mensajería para juegos: IDs de jugador, etiquetas de ciclo de vida, eventos de comportamiento, segmentos y Journeys para juegos móviles. - [Estrategias financieras y fintech](https://documentation.onesignal.com/docs/es/financial-fintech-industry.md): Guía de mensajería financiera y fintech: IDs de usuario, etiquetas de KYC y seguridad, eventos de transacciones, segmentos y Journeys de retención. - [Estrategias de noticias y medios](https://documentation.onesignal.com/docs/es/news-and-media-industry.md): Guía de mensajería para noticias y medios: IDs de usuario, etiquetas de interés, eventos de lectura, segmentos y Journeys para crecimiento y reenganche. #### 📈 Aumentar el compromiso y la retención - [Tutorial de carrito abandonado](https://documentation.onesignal.com/docs/es/abandoned-cart.md): Recupere ventas perdidas con notificaciones de carrito abandonado usando OneSignal mediante el seguimiento de la actividad del carrito, la creación de segmentos dirigidos y el envío de recordatorios oportunos con Journeys. - [Crear feed de actividad](https://documentation.onesignal.com/docs/es/create-an-activity-feed.md): Aprenda cómo crear un feed de actividad dentro de la aplicación usando la API REST de OneSignal, Event Streams o lógica en el dispositivo para rastrear y mostrar el historial de notificaciones del usuario. - [Confirmación de reserva y recuperación de reserva abandonada](https://documentation.onesignal.com/docs/es/booking-confirmations.md): Use eventos personalizados, Journeys y Data Feeds para enviar correos de confirmación de reserva o recuperación basados en el estado de la reserva en tiempo real. - [Construir un carrusel de onboarding con botones](https://documentation.onesignal.com/docs/es/in-app-onboarding-carousel-tutorial.md): Crea un flujo de onboarding de múltiples pasos usando Mensajes In-App HTML con navegación por botones y cierre automático. - [Actividad social](https://documentation.onesignal.com/docs/es/social-activity.md): Envía push, email y SMS para acciones sociales como me gusta, seguimientos y mensajes directos. Usa custom_data para alertas desde el backend. - [Orientar versiones antiguas de aplicaciones para fomentar actualizaciones](https://documentation.onesignal.com/docs/es/app-version-update.md): Usa mensajes en la aplicación para detectar versiones antiguas y solicitar a los usuarios que actualicen, con segmentos específicos por plataforma para iOS y Android. - [Obtén más reseñas en la app store](https://documentation.onesignal.com/docs/es/example-app-store-review.md): Solicita a los usuarios que reseñen tu aplicación usando mensajes in-app de OneSignal con las solicitudes de reseña nativas de iOS y Android, reduciendo la fricción y aumentando las calificaciones. - [Incorporar usuarios con mensajes in-app de banner](https://documentation.onesignal.com/docs/es/example-create-a-tutorial.md): Guía a los usuarios con mensajes in-app de banner contextuales en la parte superior e inferior que no bloquean la interfaz de tu aplicación. #### 🔔 Entregar mensajes críticos o de alta prioridad - [Mensajes transaccionales](https://documentation.onesignal.com/docs/es/transactional-messages.md): Aprende cómo enviar mensajes transaccionales como OTPs, actualizaciones de facturación y recordatorios usando el API de OneSignal con datos personalizados vía push, email o SMS. - [Mensajes de respaldo: Asegurar entrega entre canales](https://documentation.onesignal.com/docs/es/push-fallback-method.md): Implementa una estrategia de respaldo con OneSignal para asegurar que los mensajes críticos se entreguen por email o SMS cuando las notificaciones push fallen. Aprende cómo configurar mensajería entre canales usando Journeys, APIs y segmentación para participación confiable del usuario. - [Mensajes basados en ubicación](https://documentation.onesignal.com/docs/es/location-triggered-event.md): Segmenta usuarios por país, coordenadas GPS o geofence y envía notificaciones push activadas por ubicación con OneSignal. #### 🧠 Mejorar el enfoque y la personalización - [Etiquetar usuarios por tema de página y origen de suscripción](https://documentation.onesignal.com/docs/es/auto-segment-users-by-page-visit.md): Etiqueta usuarios en OneSignal según las páginas que visitan y la página desde la que se suscriben a notificaciones push, luego segmenta para campañas dirigidas. - [Solicitar permisos de ubicación con mensajes in-app](https://documentation.onesignal.com/docs/es/location-opt-in-prompt.md): Guía a los usuarios para habilitar el seguimiento de ubicación en tu app móvil usando un pre-aviso suave en OneSignal antes de activar la solicitud de permiso de ubicación nativa de Android o iOS. - [Crear una encuesta para solicitar retroalimentación](https://documentation.onesignal.com/docs/es/example-create-a-survey.md): Crea una encuesta in-app de múltiples páginas usando Carrusel, Acciones de clic de botón, Outcomes y Etiquetas para análisis y segmentación. - [Orientar ciertos fabricantes y dispositivos Android](https://documentation.onesignal.com/docs/es/example-target-certain-android-manufacturers-and-devices.md): Identifica y orienta dispositivos Android de fabricantes conocidos por bloquear notificaciones push cuando se desliza la aplicación, y usa mensajes in-app para educar a los usuarios sobre cómo habilitar la configuración adecuada. #### 🛠️ Mejorar la experiencia del usuario y la incorporación - [Configurar confirmación de adhesión para correo electrónico](https://documentation.onesignal.com/docs/es/double-opt-in-email.md): Aprenda cómo implementar un proceso de doble confirmación de adhesión (confirmed opt-in) en OneSignal usando Etiquetas, Segmentos y Journeys para mejorar el compromiso, el cumplimiento y la calidad de la lista. - [Centro de preferencias](https://documentation.onesignal.com/docs/es/preference-center.md): Aprende cómo implementar un centro de preferencias de usuario personalizado en tu app o sitio web usando las APIs de OneSignal para gestionar temas de notificaciones, frecuencias, canales y configuraciones de privacidad de datos. - [Enviar verificación, magic link, OTP y mensajes de doble opt-in](https://documentation.onesignal.com/docs/es/example-verification-magic-link-otp.md): Ejemplos de mensajes de verificación de email y SMS usando OneSignal, incluyendo contraseñas de un solo uso, magic links y flujos de doble opt-in con plantillas y ejemplos de API. - [iOS: Notificaciones push con carrusel de imágenes](https://documentation.onesignal.com/docs/es/ios-image-carousel-push-notifications.md): Cómo implementar un carrusel de imágenes en notificaciones push de iOS de OneSignal usando Swift. ### API Reference #### Using the REST APIs - [REST API overview](https://documentation.onesignal.com/reference/rest-api-overview.md): Programmatic access to OneSignal messaging, user management, segments, Journeys, and data exports over HTTPS with rate limiting and retry support. - [Rate limits and error handling](https://documentation.onesignal.com/reference/rate-limits.md): Understand OneSignal API and application rate limits, common errors, retry behavior, and how to safely recover from failures without sending duplicate messages or disabling your app. #### API reference ##### Messages - [Sending messages with the OneSignal API](https://documentation.onesignal.com/reference/create-message.md): Send push notifications, emails, SMS, and Live Activities with the OneSignal API. Covers audience targeting, message composition, scheduling, and response handling. - [Idempotent API requests](https://documentation.onesignal.com/reference/idempotent-notification-requests.md): Prevent duplicate messages or custom events when retrying API requests. - [Push notification](https://documentation.onesignal.com/reference/push-notification.md): Send a message using the push notification channel. - [Email](https://documentation.onesignal.com/reference/email.md): Send a message using the email channel. - [SMS](https://documentation.onesignal.com/reference/sms.md): Send a message using the SMS channel. - [View message](https://documentation.onesignal.com/reference/view-message.md): View the details of a single message and the Outcomes associated with it. - [View messages](https://documentation.onesignal.com/reference/view-messages.md): View the details for a collection of messages. - [Cancel message](https://documentation.onesignal.com/reference/cancel-message.md): Stop a scheduled or currently outgoing message. - [Message history](https://documentation.onesignal.com/reference/message-history.md): View which subscriptions received a particular message - [Estimated recipients](https://documentation.onesignal.com/reference/count-unsaved.md): Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. ##### Live Activities - [Start Live Activity](https://documentation.onesignal.com/reference/start-live-activity.md): Remotely start an iOS Live Activity with the OneSignal REST API, also known as push-to-start. Covers required body fields, choosing an activity_id, and audience targeting. - [Update Live Activity](https://documentation.onesignal.com/reference/update-live-activity-api.md): Update the content of a running iOS Live Activity or end it with the OneSignal REST API. Covers required body fields, update priority, and dismissal timing. ##### Custom Events - [Create custom events](https://documentation.onesignal.com/reference/create-custom-events.md): The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones. ##### Users - [Create user](https://documentation.onesignal.com/reference/create-user.md): Create a new user or modify the subscriptions associated with an existing User. - [View user](https://documentation.onesignal.com/reference/view-user.md): Retrieve a user including aliases, properties, and subscriptions. - [Update user](https://documentation.onesignal.com/reference/update-user.md): Modify a user's properties. - [Delete user](https://documentation.onesignal.com/reference/delete-user.md): Delete a user including all associated properties, subscriptions, and identity. - [View user identity](https://documentation.onesignal.com/reference/fetch-aliases.md): Retrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias. This API helps you map back to a user's full identity from any one piece of identifying information. - [View user identity (by subscription)](https://documentation.onesignal.com/reference/fetch-identity-by-subscription.md): Retrieve all aliases linked to a user using a known `subscription_id`. This is useful when the user's identity is unknown but you have access to one of their push, email, or SMS subscriptions. - [Create or update alias](https://documentation.onesignal.com/reference/create-alias.md): Add or update aliases on an existing user when you already know one of that user's aliases, such as an external_id, onesignal_id, or custom alias. Updates the identity object only. - [Create alias (by subscription)](https://documentation.onesignal.com/reference/create-alias-by-subscription.md): Create or update an alias for a user using a known subscription ID. - [Delete alias](https://documentation.onesignal.com/reference/delete-alias.md): Remove a specific alias from a user. ##### Subscriptions - [Create Subscription by alias](https://documentation.onesignal.com/reference/create-subscription.md): Attach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias. - [Update Subscription by ID](https://documentation.onesignal.com/reference/update-subscription.md): Update properties on an existing OneSignal subscription using its subscription_id. Commonly used to enable or disable a subscription when managing outside of the OneSignal SDK. - [Update Subscription by token](https://documentation.onesignal.com/reference/update-subscription-by-token.md): Update properties on an existing Subscription using its token. Commonly used to enable or disable subscription status when managing outside of the OneSignal SDK. - [Delete Subscription](https://documentation.onesignal.com/reference/delete-subscription.md): Delete a specific subscription by its subscription_id. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token. - [Transfer Subscription](https://documentation.onesignal.com/reference/transfer-subscription.md): Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity. - [Unsubscribe email with token](https://documentation.onesignal.com/reference/unsubscribe-with-token.md): Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach. ##### Templates - [Create template](https://documentation.onesignal.com/reference/create-template.md): Create reusable message templates for push, email, and SMS channels. Templates can be accessed through both the dashboard and API using a `template_id`. - [Update template](https://documentation.onesignal.com/reference/update-template.md): Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the `template_id` reference. - [View templates](https://documentation.onesignal.com/reference/view-templates.md): Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps. - [View template](https://documentation.onesignal.com/reference/view-template.md): Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update. - [Delete template](https://documentation.onesignal.com/reference/delete-template.md): Permanently delete a specific message template from your OneSignal app using its template ID. Templates used in Journeys must be removed from those Journeys before deletion. - [Copy template to another app](https://documentation.onesignal.com/reference/copy-template-to-another-app.md): Create a duplicate of a template in another app. The new template will be completely separate from the original (including having a new template_id) but will be created with all the same content. ##### Segments - [View segments](https://documentation.onesignal.com/reference/view-segments.md): Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status. - [View segment](https://documentation.onesignal.com/reference/view-segment.md): Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters. - [Create segment](https://documentation.onesignal.com/reference/create-segments.md): Programmatically create segments in your OneSignal app using flexible filters and targeting rules. - [Update segment](https://documentation.onesignal.com/reference/update-segment.md): Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones. - [Delete segment](https://documentation.onesignal.com/reference/delete-segments.md): Delete segments from OneSignal. Does not delete users or subscriptions. ##### Journeys - [View journeys](https://documentation.onesignal.com/reference/view-journeys.md): Retrieve a paginated list of journeys for an app, with cursor-based pagination and a lightweight summary representation of each journey. - [View journey](https://documentation.onesignal.com/reference/view-journey.md): Retrieve the full configuration of a single journey by its UUID, including its audience, schedule, and node graph. - [View journey stats](https://documentation.onesignal.com/reference/view-journey-stats.md): Retrieve performance stats for a single journey, including journey-level counts, per-node counts, per-branch counts, and channel delivery stats. - [Create journey](https://documentation.onesignal.com/reference/create-journey.md): Create a new journey with an audience and a node graph. Journeys are always created in the draft state. - [Duplicate journey](https://documentation.onesignal.com/reference/duplicate-journey.md): Copy an existing journey into a new draft. You can apply overrides to the copy in the same request. - [Update journey](https://documentation.onesignal.com/reference/update-journey.md): Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state. - [Update journey node](https://documentation.onesignal.com/reference/update-journey-node.md): Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch. - [Delete journey](https://documentation.onesignal.com/reference/delete-journey.md): Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data. ##### Configuration - [View apps](https://documentation.onesignal.com/reference/view-apps.md): Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API. - [View an app](https://documentation.onesignal.com/reference/view-an-app.md): View the details of a single OneSignal app - [Create an app](https://documentation.onesignal.com/reference/create-an-app.md): Programmatically create a new OneSignal app via the REST API. This guide explains required fields, supported platform configurations (Web, Android, iOS), and how to properly authenticate using your Organization API key. - [Update an app](https://documentation.onesignal.com/reference/update-an-app.md): Use to update the name or push platform configuration of an existing app. This guide explains required parameters and platform-specific update rules - [View API keys](https://documentation.onesignal.com/reference/view-api-keys.md): View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app. - [Create API key](https://documentation.onesignal.com/reference/create-api-key.md): Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation. - [Delete API key](https://documentation.onesignal.com/reference/delete-api-key.md): Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token's unique ID, not the token value itself. - [Update API key](https://documentation.onesignal.com/reference/update-api-key.md): Update a Rich Authentication Token (App API Key) for a OneSignal app. Modify the token's name or IP allowlist settings using your Organization API Key. - [Rotate API key](https://documentation.onesignal.com/reference/rotate-api-key.md): Rotate an existing App API Key (Rich Authentication Token) for a OneSignal app. Useful when a token is compromised or needs replacement without creating a new key from scratch. ##### Analytics - [Export subscriptions CSV](https://documentation.onesignal.com/reference/csv-export.md): Generate a GZip-compressed CSV export of your current subscription data using this API endpoint. - [Export audience activity CSV](https://documentation.onesignal.com/reference/export-csv-of-events.md): Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels. - [View outcomes](https://documentation.onesignal.com/reference/view-outcomes.md): View and export push notification outcome metrics such as clicks, conversions, and custom events. ##### Deprecated - [View players](https://documentation.onesignal.com/reference/view-devices.md): GET `https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}` - [View player](https://documentation.onesignal.com/reference/view-device.md): GET https://onesignal.com/api/v1/players/{player_id} - [Add a player](https://documentation.onesignal.com/reference/add-a-device.md): POST `https://onesignal.com/api/v1/players` - [Edit player](https://documentation.onesignal.com/reference/edit-device.md): put https://onesignal.com/api/v1/players/{player_id} - [Edit tags with external user id](https://documentation.onesignal.com/reference/edit-tags-with-external-user-id.md): put https://onesignal.com/api/v1/apps/{app_id}/users/{external_user_id} - [Delete player record](https://documentation.onesignal.com/reference/delete-user-record.md): delete https://onesignal.com/api/v1/players/{player_id}?app_id={app_id} #### SDKs - [Server SDK reference](https://documentation.onesignal.com/docs/en/server-sdk-reference.md): Install, configure, and use OneSignal server SDKs to send push notifications, emails, and SMS from your backend in Node.js, Python, Java, Go, PHP, Ruby, C#, and Rust. ### Release Notes #### Release Notes - [Changelog](https://documentation.onesignal.com/release-notes/changelog.md): Follow the OneSignal changelog for new features, product updates, and bug fixes across push, email, SMS, in-app messages, Journeys, and analytics. - [SDK Releases](https://documentation.onesignal.com/release-notes/sdk-releases.md): View the latest OneSignal SDK releases and updates. ## OpenAPI Specs - [openapi](/openapi.json) ## Optional - [Blog](https://onesignal.com/blog) - [GitHub](https://github.com/OneSignal) - [YouTube](https://www.youtube.com/@onesignalofficial/playlists)