# OneSignal: Brazilian Portuguese > OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard. ## Brazilian Portuguese - [Brazilian Portuguese / Guia do Usuário (178 pages)](https://documentation.onesignal.com/_llms/pt-br/guia-do-usuario.md): Documentation for Brazilian Portuguese / Guia do Usuário. ### Início - [Documentação OneSignal](https://documentation.onesignal.com/docs/pt-BR/home.md): Comece a construir mais rápido com OneSignal. Explore quickstarts, SDKs, canais de mensagens, referências de API e recursos avançados como Journeys e Live Activities. ### Guia de desenvolvedor #### Documentação de desenvolvedor - [Desenvolvedores](https://documentation.onesignal.com/docs/pt-BR/developers.md): Configure os SDKs móvel e web do OneSignal, encontre seu App ID e chaves de API, identifique Usuários e teste sua integração antes de ir ao ar. - [Verificação de identidade](https://documentation.onesignal.com/docs/pt-BR/identity-verification.md): Previna a falsificação de identidade de usuários exigindo JWTs gerados pelo servidor para verificar IDs de Usuário Externos, emails e assinaturas de SMS enviados ao OneSignal. ##### Modelo de usuário - [User model & guia de migração](https://documentation.onesignal.com/docs/pt-BR/user-model-migration-guide.md): Aprenda como migrar do modelo centrado em dispositivo do OneSignal para as novas APIs e SDKs centrados em usuário para engajamento multi-canal mais personalizado. - [Mapeamento de SDK Mobile](https://documentation.onesignal.com/docs/pt-BR/device-user-model-mobile-sdk-mapping.md): Compare nomes de métodos e propriedades entre o Player Model legado do OneSignal (v3 e v4) e o User Model moderno (v5+), com exemplos de código Swift lado a lado para facilitar a migração. - [Mapeamento de SDK Web](https://documentation.onesignal.com/docs/pt-BR/device-user-model-web-sdk-mapping.md): Compare métodos do OneSignal Web SDK entre o Player Model legado e o novo User Model. Aprenda como migrar sua implementação com exemplos de código baseados em TypeScript e referências de métodos atualizadas. #### SDKs móveis ##### Configuração do SDK móvel - [Configuração do Mobile SDK](https://documentation.onesignal.com/docs/pt-BR/mobile-sdk-setup.md): Configure o SDK do OneSignal para Android, iOS, Huawei, Amazon e frameworks multiplataforma como React Native, Expo, Flutter, Unity, Cordova e Capacitor. - [Configuração do SDK iOS](https://documentation.onesignal.com/docs/pt-BR/ios-sdk-setup.md): Como adicionar notificações push e mensagens no aplicativo ao seu aplicativo iOS com o OneSignal. - [Configuração do SDK Android](https://documentation.onesignal.com/docs/pt-BR/android-sdk-setup.md): Instale o SDK Android da OneSignal no Android Studio para adicionar push e mensagens in-app, com credenciais FCM, inicialização e testes. - [Configuração do Unity SDK](https://documentation.onesignal.com/docs/pt-BR/unity-sdk-setup.md): Configure o Unity SDK do OneSignal para adicionar notificações push a apps Unity em iOS, Android, Amazon e Huawei, da instalação à inicialização. - [Configuração do SDK React Native](https://documentation.onesignal.com/docs/pt-BR/react-native-sdk-setup.md): Guia completo para integrar o OneSignal React Native SDK para plataformas de aplicativos iOS, Android e Amazon. Inclui pré-requisitos, etapas de configuração, configuração específica da plataforma e solução de problemas comuns. - [Configuração do SDK Expo](https://documentation.onesignal.com/docs/pt-BR/react-native-expo-sdk-setup.md): Integre o OneSignal Expo SDK em seus aplicativos iOS e Android usando Expo SDK 53+ e EAS Build para notificações push e mensagens in-app. - [Configuração do SDK Flutter](https://documentation.onesignal.com/docs/pt-BR/flutter-sdk-setup.md): Instruções para adicionar o SDK OneSignal Flutter ao seu aplicativo Flutter para iOS e Android - [Configuração do SDK Flutterflow](https://documentation.onesignal.com/docs/pt-BR/flutterflow-sdk-setup.md): Instruções para adicionar o SDK OneSignal Flutter ao seu aplicativo Flutterflow para iOS e Android - [Configuração do SDK Cordova](https://documentation.onesignal.com/docs/pt-BR/cordova-sdk-setup.md): Configure o SDK Cordova do OneSignal para adicionar notificações push a apps Cordova, Ionic e Capacitor em iOS e Android, da instalação ao service worker. - [Configuração do SDK Capacitor](https://documentation.onesignal.com/docs/pt-BR/capacitor-sdk-setup.md): Configure o OneSignal Capacitor SDK para adicionar notificações push em aplicativos Capacitor para iOS e Android. - [Configuração do SDK .NET MAUI](https://documentation.onesignal.com/docs/pt-BR/net-sdk-setup.md): Instruções para adicionar o SDK .NET do OneSignal ao seu aplicativo MAUI multiplataforma para iOS, Android e Desktop. - [Configuração do SDK Amazon](https://documentation.onesignal.com/docs/pt-BR/amazon-sdk-setup.md): Guia passo a passo para integrar o SDK OneSignal em seu aplicativo Amazon Fire OS para notificações push e capacidades de mensagens no aplicativo. - [Configuração do SDK Huawei](https://documentation.onesignal.com/docs/pt-BR/huawei-sdk-setup.md): Guia de Configuração do SDK OneSignal Huawei para Android Studio. ###### Configuração de credenciais da plataforma - [Credenciais do Android Firebase](https://documentation.onesignal.com/docs/pt-BR/android-firebase-credentials.md): Configure as credenciais de Conta de Serviço do Firebase Cloud Messaging (FCM) no OneSignal para habilitar notificações push do Android para aplicativos na Google Play Store. - [iOS: Conexão baseada em token p8 para APNs](https://documentation.onesignal.com/docs/pt-BR/ios-p8-token-based-connection-to-apns.md): Configure uma chave de autenticação .p8 para conectar seu app iOS ou macOS ao Apple Push Notification service (APNs) através do OneSignal. - [Geração de certificado p12 para iOS](https://documentation.onesignal.com/docs/pt-BR/ios-p12-generate-certificates.md): Gere e faça upload de um certificado push .p12 para conectar seu aplicativo iOS ou macOS ao Apple Push Notification service (APNs) pelo OneSignal. - [Geração de chave API da Amazon](https://documentation.onesignal.com/docs/pt-BR/generate-an-amazon-api-key.md): Guia passo a passo - [Autorização Huawei](https://documentation.onesignal.com/docs/pt-BR/authorize-onesignal-to-send-huawei-push.md): Guia passo a passo para conectar seu aplicativo Huawei ao OneSignal para notificações push, incluindo configuração do PushKit, configuração de chave de API e autoclassificação opcional de mensagens da Huawei para aplicativos com usuários na China. ##### Referência do SDK móvel - [Referência do Mobile SDK](https://documentation.onesignal.com/docs/pt-BR/mobile-sdk-reference.md): Referência da API do Mobile SDK do OneSignal: inicialização, identidade de usuário, subscriptions, tags, permissões, mensagens in-app e Live Activities. - [Extensões de Serviço Móvel](https://documentation.onesignal.com/docs/pt-BR/service-extensions.md): Intercepte e personalize push antes da exibição no iOS e Android: rich media, entrega confirmada, estilo personalizado e dados em segundo plano. - [Gerenciando a bandeja de notificações](https://documentation.onesignal.com/docs/pt-BR/managing-the-notification-tray.md): Como as notificações push móveis do OneSignal se comportam na bandeja de notificações no Android e iOS: tratamento de clique e dispensa, notificações restauradas, badges, limpeza de notificações programaticamente e extensões de serviço. - [Payload do OSNotification](https://documentation.onesignal.com/docs/pt-BR/osnotification-payload.md): Referência para o objeto OSNotification do OneSignal, incluindo todos os campos de payload, propriedades específicas do Android e iOS, dados personalizados e ações de clique. - [iOS: Suporte a App Clip](https://documentation.onesignal.com/docs/pt-BR/app-clip-support.md): Aprenda como habilitar e configurar notificações push do OneSignal em iOS App Clips. Cobre etapas de configuração, limitações e suporte para experiências avançadas como Target-Content-ID. ##### Solução de problemas do SDK móvel - [Solução de problemas do SDK Mobile](https://documentation.onesignal.com/docs/pt-BR/mobile-troubleshooting.md): Resolva problemas comuns do OneSignal Mobile SDK, incluindo falhas na entrega push, erros APNS e problemas de mensagens in-app no iOS, Android e frameworks cross-platform. - [Obtendo um log de depuração](https://documentation.onesignal.com/docs/pt-BR/capturing-a-debug-log.md): Aprenda como capturar logs de depuração detalhados do seu aplicativo móvel usando o SDK OneSignal. Este guia orienta sobre como ativar o log detalhado, reproduzir problemas e compartilhar logs para solucionar problemas de notificação push nas plataformas Android e iOS. #### SDKs web - [Referência do Web SDK](https://documentation.onesignal.com/docs/pt-BR/web-sdk-reference.md): Referência completa da API do OneSignal Web SDK v16: inicialização, login, propriedades de usuário, subscriptions de push, prompts slidedown e event listeners. ##### Configuração do SDK web - [Configuração do Web SDK](https://documentation.onesignal.com/docs/pt-BR/web-sdk-setup.md): Adicione notificações web push do OneSignal ao seu website com o SDK JavaScript, configuração do service worker e configuração do dashboard. - [Configuração de web push para iOS](https://documentation.onesignal.com/docs/pt-BR/web-push-for-ios.md): Guia completo para habilitar notificações web push em dispositivos iOS e iPadOS, incluindo configuração de arquivo manifest, estratégias de onboarding de usuário e melhores práticas de implementação para navegadores Safari, Chrome e Edge. - [OneSignal service worker](https://documentation.onesignal.com/docs/pt-BR/onesignal-service-worker.md): Configure o arquivo OneSignalSDKWorker.js para que seu site possa receber e exibir notificações push web através do OneSignal. - [Configuração de push web com código personalizado](https://documentation.onesignal.com/docs/pt-BR/web-push-custom-code-setup.md): Configure push web do OneSignal com código personalizado: adicione o SDK JavaScript, configure o service worker e inicialize o OneSignal no site. - [Google Tag Manager setup](https://documentation.onesignal.com/docs/en/google-tag-manager.md): Add OneSignal Web Push to your website using Google Tag Manager (GTM), including service worker setup, initialization, and sending Tags safely. - [Configuração do SDK Web Angular](https://documentation.onesignal.com/docs/pt-BR/angular-setup.md): Integre notificações Web Push do OneSignal em seu aplicativo Angular usando o pacote onesignal-ngx. Aprenda como instalar, configurar e solucionar problemas de service workers para entregar notificações push perfeitas. - [Configuração ReactJS & NextJS](https://documentation.onesignal.com/docs/pt-BR/react-js-setup.md): Aprenda como integrar notificações push do OneSignal com seu aplicativo web ReactJS ou NextJS, incluindo inicialização, configuração do service worker e suporte ao TypeScript. - [Configuração do Vue JS Web SDK](https://documentation.onesignal.com/docs/pt-BR/vue-js-setup.md): Integre notificações Web Push do OneSignal em sua aplicação Vue.js usando o plugin onesignal-vue ou @onesignal/onesignal-vue3. Aprenda como instalar, configurar e personalizar service workers para entrega perfeita de push. ##### Solução de problemas do SDK web - [Solução de problemas do Web SDK](https://documentation.onesignal.com/docs/pt-BR/troubleshooting-web-push.md): Solucione problemas de Web Push do OneSignal incluindo erros de service worker, incompatibilidades de origem, tipos MIME e notificações não exibidas. - [Limpar cache e redefinir permissões push](https://documentation.onesignal.com/docs/pt-BR/clearing-cache-and-resetting-push-permissions.md): Aprenda como redefinir permissões push do navegador, service workers e dados do site no Chrome, Firefox e Safari para garantir ambientes de teste limpos e resolver problemas de notificação push da web. - [Webhooks de web push](https://documentation.onesignal.com/docs/pt-BR/webhooks.md): Configure webhooks HTTP para receber notificações em tempo real quando usuários exibem, clicam ou dispensam notificações web push. Guia completo com exemplos para suporte de navegadores Chrome, Firefox e Safari. #### Atividades ao Vivo - [Configuração de desenvolvedor para Live Activities](https://documentation.onesignal.com/docs/pt-BR/live-activities-developer-setup.md): Configure Live Activities do iOS com OneSignal para exibir atualizações em tempo real na tela de bloqueio e Dynamic Island. - [Configuração do SDK de Live Activity multiplataforma](https://documentation.onesignal.com/docs/pt-BR/cross-platform-live-activity-setup.md): Adicione Live Activities do iOS a apps React Native, Flutter, Unity, Cordova, Capacitor ou .NET MAUI: com setupDefault, o SDK gerencia o ActivityKit. - [Notificações Live Update no Android](https://documentation.onesignal.com/docs/pt-BR/android-live-notifications.md): Crie Live Updates no Android com push do OneSignal: uma Notification Service Extension atualiza uma notificação persistente, como Live Activities do iOS. #### Configuração de Desktop & Watch - [Configuração de aplicativo macOS](https://documentation.onesignal.com/docs/pt-BR/macos-app-setup.md): Aprenda como integrar OneSignal em seu aplicativo macOS, seja usando Mac Catalyst ou acesso direto à API. Orientação passo a passo para configurar plataformas, instalar o SDK e enviar notificações push. - [Configuração de app Windows](https://documentation.onesignal.com/docs/pt-BR/windows-app-setup.md): Guia completo para integrar notificações push OneSignal no seu app Universal Windows Platform (UWP) usando Windows Push Notification Service (WNS) e REST API do OneSignal - [Suporte a watchOS & Wear OS](https://documentation.onesignal.com/docs/pt-BR/watchos-and-wear-os-support.md): Guia completo para implementar notificações push do OneSignal para aplicações standalone Apple watchOS e Android Wear OS, incluindo instruções de configuração e integração de API. ### Tutoriais #### Tutoriais - [Tutorials & use cases](https://documentation.onesignal.com/docs/pt-BR/tutorials.md): Explore tutoriais passo a passo e exemplos de melhores práticas para ajudá-lo a implementar recursos do OneSignal e aumentar engajamento, retenção e receita. #### Por setor - [Estratégias para jogos](https://documentation.onesignal.com/docs/pt-BR/gaming-industry.md): Hub de mensagens para jogos: IDs de jogadores, Tags de ciclo de vida, Custom Events comportamentais, segmentos e playbooks de Journeys para jogos mobile. - [Estratégias para finanças e fintech](https://documentation.onesignal.com/docs/pt-BR/financial-fintech-industry.md): Hub de mensagens para finanças e fintech: IDs de usuário, Tags de KYC e segurança, Custom Events de transações, segmentos e playbooks de Journeys. - [Estratégias para notícias e mídia](https://documentation.onesignal.com/docs/pt-BR/news-and-media-industry.md): Hub de mensagens para notícias e mídia: IDs de usuário, Tags de interesse, Custom Events de leitura, segmentos e Journeys para paywall e reengajamento. #### Aumentar a engajamento e a retenção - [Tutorial de carrinho abandonado](https://documentation.onesignal.com/docs/pt-BR/abandoned-cart.md): Recupere vendas perdidas com notificações de carrinho abandonado usando o OneSignal. Aprenda como rastrear a atividade do carrinho, construir o segmento certo e enviar lembretes oportunos com Journeys. - [Criar feed de atividades](https://documentation.onesignal.com/docs/pt-BR/create-an-activity-feed.md): Aprenda como criar um feed de atividades dentro do aplicativo usando a API REST do OneSignal, Event Streams ou lógica no dispositivo para rastrear e exibir o histórico de notificações do usuário. - [Confirmação de reserva e recuperação de reserva abandonada](https://documentation.onesignal.com/docs/pt-BR/booking-confirmations.md): Use eventos personalizados, Journeys e Data Feeds para enviar emails de confirmação de reserva ou recuperação baseados no status da reserva em tempo real. - [Construir um carrossel de onboarding com botões](https://documentation.onesignal.com/docs/pt-BR/in-app-onboarding-carousel-tutorial.md): Crie um fluxo de onboarding de várias etapas usando Mensagens In-App HTML com navegação por botões e fechamento automático. - [Atividade social](https://documentation.onesignal.com/docs/pt-BR/social-activity.md): Envie push, email e SMS para ações sociais como curtidas, seguidas e mensagens diretas, usando custom_data para alertas acionados pelo backend. - [Direcionar versões desatualizadas do aplicativo para incentivar atualizações](https://documentation.onesignal.com/docs/pt-BR/app-version-update.md): Use mensagens in-app para detectar versões desatualizadas do app e solicitar que os usuários atualizem, com segmentos específicos por plataforma para iOS e Android. - [Obtenha mais avaliações na loja de aplicativos](https://documentation.onesignal.com/docs/pt-BR/example-app-store-review.md): Solicite aos usuários uma avaliação na App Store ou Google Play usando mensagens in-app do OneSignal com prompts de avaliação nativos do iOS e Android, reduzindo o atrito e aumentando as classificações. - [Integrar usuários com mensagens in-app de banner](https://documentation.onesignal.com/docs/pt-BR/example-create-a-tutorial.md): Guie os usuários com mensagens in-app de banner contextuais no topo e na parte inferior que não bloqueiam a interface do seu aplicativo. #### Entregar mensagens críticas ou de alta prioridade - [Transactional messages](https://documentation.onesignal.com/docs/pt-BR/transactional-messages.md): Aprenda como enviar mensagens transacionais como OTPs, atualizações de cobrança e lembretes usando a API do OneSignal com dados personalizados via push, email ou SMS. - [Mensagens de fallback: Garantindo entrega entre canais](https://documentation.onesignal.com/docs/pt-BR/push-fallback-method.md): Implemente uma estratégia de fallback com o OneSignal para garantir que mensagens críticas sejam entregues por email ou SMS quando notificações push falharem. Aprenda como configurar mensagens entre canais usando Jornadas, APIs e segmentação para engajamento confiável do usuário. - [Mensagens baseadas em localização](https://documentation.onesignal.com/docs/pt-BR/location-triggered-event.md): Segmente usuários por país, coordenadas GPS ou geofence e envie notificações push acionadas por localização com OneSignal. #### Aprimorar o targeting e a personalização - [Marcar usuários por tópico de página e origem da assinatura](https://documentation.onesignal.com/docs/pt-BR/auto-segment-users-by-page-visit.md): Marque usuários no OneSignal com base nas páginas que visitam e na página em que se inscrevem para notificações push, depois segmente para campanhas direcionadas. - [Solicitar permissões de localização com mensagens in-app](https://documentation.onesignal.com/docs/pt-BR/location-opt-in-prompt.md): Oriente usuários a habilitar rastreamento de localização em seu aplicativo mobile usando um soft pre-prompt no OneSignal antes de acionar a solicitação de permissão de localização nativa do Android ou iOS. - [Criar uma pesquisa para solicitar feedback](https://documentation.onesignal.com/docs/pt-BR/example-create-a-survey.md): Crie uma pesquisa in-app de várias páginas usando Carousel, Ações de Clique de Botão, Resultados e Tags para análise e segmentação. - [Segmentar certos fabricantes e dispositivos Android](https://documentation.onesignal.com/docs/pt-BR/example-target-certain-android-manufacturers-and-devices.md): Identifique e segmente dispositivos Android de fabricantes conhecidos por bloquear notificações push quando os aplicativos são fechados, e use mensagens in-app para educar os usuários sobre como habilitar as configurações adequadas. #### Aprimorar a experiência do usuário e o onboarding - [Configurar opt-in confirmado para email](https://documentation.onesignal.com/docs/pt-BR/double-opt-in-email.md): Aprenda como implementar um processo de opt-in duplo (opt-in confirmado) no OneSignal usando Tags, Segmentos e Jornadas para melhorar engajamento, conformidade e qualidade da lista. - [Central de preferências](https://documentation.onesignal.com/docs/pt-BR/preference-center.md): Aprenda como implementar uma central de preferências de usuário personalizada em seu aplicativo ou site usando as APIs do OneSignal para gerenciar tópicos de notificação, frequências, canais e configurações de privacidade de dados. - [Enviar mensagens de verificação, magic link, OTP e dupla aceitação](https://documentation.onesignal.com/docs/pt-BR/example-verification-magic-link-otp.md): Exemplos de mensagens de verificação de email e SMS usando OneSignal, incluindo senhas de uso único, magic links e fluxos de dupla aceitação com modelos e exemplos de API. - [iOS: Notificações push com carrossel de imagens](https://documentation.onesignal.com/docs/pt-BR/ios-image-carousel-push-notifications.md): Como implementar um carrossel de imagens em notificações push do OneSignal para iOS 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 - [Referência do SDK do Servidor](https://documentation.onesignal.com/docs/pt-BR/server-sdk-reference.md): Instale, configure e use os SDKs de servidor do OneSignal para enviar notificações push, emails e SMS do seu backend em Node.js, Python, Java, Go, PHP, Ruby, C# e 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)