# OneSignal: French > OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard. ## French - [French / Guides utilisateur (178 pages)](https://documentation.onesignal.com/_llms/fr/guides-utilisateur.md): Documentation for French / Guides utilisateur. ### Accueil - [Documentation OneSignal](https://documentation.onesignal.com/docs/fr/home.md): Commencez à développer plus rapidement avec OneSignal. Explorez les guides de démarrage rapide, les SDK, les canaux de messagerie, les références API et les fonctionnalités avancées comme les Journeys et les Live Activities. ### Guides développeur #### Documentation développeur - [Développeurs](https://documentation.onesignal.com/docs/fr/developers.md): Configurez les SDK mobile et web OneSignal, trouvez votre App ID et vos clés API, identifiez les Utilisateurs et testez votre intégration avant le lancement. - [Vérification d'identité](https://documentation.onesignal.com/docs/fr/identity-verification.md): Prévenez l'usurpation d'identité des utilisateurs en exigeant des JWT générés par le serveur pour vérifier les ID d'utilisateur externes, les emails et les abonnements SMS envoyés à OneSignal. ##### Modèle utilisateur - [Modèle utilisateur et guide de migration](https://documentation.onesignal.com/docs/fr/user-model-migration-guide.md): Apprenez à migrer du modèle centré sur l'appareil de OneSignal vers les nouvelles API et SDK centrés sur l'utilisateur pour un engagement multicanal plus personnalisé. - [Mapping SDK mobile](https://documentation.onesignal.com/docs/fr/device-user-model-mobile-sdk-mapping.md): Comparez les noms de méthodes et de propriétés entre le modèle Player hérité de OneSignal (v3 & v4) et le modèle utilisateur moderne (v5+), avec des exemples de code Swift côte à côte pour faciliter la migration. - [Mapping SDK web](https://documentation.onesignal.com/docs/fr/device-user-model-web-sdk-mapping.md): Comparez les méthodes du SDK web OneSignal entre le modèle Player hérité et le nouveau modèle utilisateur. Apprenez à migrer votre implémentation avec des exemples de code TypeScript et des références de méthodes mises à jour. #### SDK mobiles ##### Configuration SDK mobile - [Configuration du SDK mobile](https://documentation.onesignal.com/docs/fr/mobile-sdk-setup.md): Configurez le SDK OneSignal pour Android, iOS, Huawei, Amazon et les frameworks multiplateformes comme React Native, Expo, Flutter, Unity, Cordova et Capacitor. - [Configuration du SDK iOS](https://documentation.onesignal.com/docs/fr/ios-sdk-setup.md): Ajoutez des notifications push et des messages in-app à votre application iOS avec le SDK iOS de OneSignal : installation, configuration et premiers tests. - [Configuration du SDK Android](https://documentation.onesignal.com/docs/fr/android-sdk-setup.md): Installez le SDK Android OneSignal dans Android Studio pour ajouter push et messages in-app, avec identifiants FCM, initialisation et tests. - [Configuration du SDK Unity](https://documentation.onesignal.com/docs/fr/unity-sdk-setup.md): Configurez le SDK Unity OneSignal pour ajouter des notifications push à vos apps Unity iOS, Android, Amazon et Huawei, avec installation et initialisation. - [Configuration du SDK React Native](https://documentation.onesignal.com/docs/fr/react-native-sdk-setup.md): Guide complet pour intégrer le SDK OneSignal React Native pour les plateformes d'applications iOS, Android et Amazon. Comprend les prérequis, les étapes de configuration, la configuration spécifique à la plateforme et le dépannage des problèmes courants. - [Configuration du SDK Expo](https://documentation.onesignal.com/docs/fr/react-native-expo-sdk-setup.md): Intégrez le SDK Expo de OneSignal dans vos apps iOS et Android avec Expo SDK 53+ et EAS Build pour les notifications push et les messages in-app. - [Configuration du SDK Flutter](https://documentation.onesignal.com/docs/fr/flutter-sdk-setup.md): Instructions pour ajouter le SDK Flutter OneSignal à votre application Flutter pour iOS et Android - [Configuration du SDK Flutterflow](https://documentation.onesignal.com/docs/fr/flutterflow-sdk-setup.md): Instructions pour ajouter le SDK Flutter OneSignal à votre application Flutterflow pour iOS et Android - [Configuration du SDK Cordova](https://documentation.onesignal.com/docs/fr/cordova-sdk-setup.md): Configurez le SDK OneSignal Cordova pour ajouter des notifications push à vos applications Cordova et Ionic Cordova pour iOS et Android. - [Configuration du SDK Capacitor](https://documentation.onesignal.com/docs/fr/capacitor-sdk-setup.md): Configurez le SDK OneSignal Capacitor pour ajouter des notifications push aux applications Capacitor pour iOS et Android. - [Configuration du SDK .NET MAUI](https://documentation.onesignal.com/docs/fr/net-sdk-setup.md): Instructions pour ajouter le SDK .NET de OneSignal à votre application MAUI multiplateforme pour iOS, Android et Desktop. - [Configuration du SDK Amazon](https://documentation.onesignal.com/docs/fr/amazon-sdk-setup.md): Guide étape par étape pour intégrer le SDK OneSignal dans votre application Amazon Fire OS pour les notifications push et les capacités de messagerie in-app. - [Configuration du SDK Huawei](https://documentation.onesignal.com/docs/fr/huawei-sdk-setup.md): Guide de configuration du SDK OneSignal Huawei pour Android Studio. ###### Configuration des informations d'identification de plateforme - [Identifiants Firebase Android](https://documentation.onesignal.com/docs/fr/android-firebase-credentials.md): Configurez les identifiants du compte de service Firebase Cloud Messaging (FCM) dans OneSignal pour activer les notifications push Android pour les applications du Google Play Store. - [Connexion iOS p8 basée sur un jeton vers APNs](https://documentation.onesignal.com/docs/fr/ios-p8-token-based-connection-to-apns.md): Configurez une clé d'authentification .p8 pour connecter votre application iOS ou macOS au service de notification push Apple (APNs) via OneSignal. - [Génération de certificat p12 iOS](https://documentation.onesignal.com/docs/fr/ios-p12-generate-certificates.md): Générez et importez un certificat push .p12 pour connecter votre application iOS ou macOS au service de notification push Apple (APNs) via OneSignal. - [Génération de clé API Amazon](https://documentation.onesignal.com/docs/fr/generate-an-amazon-api-key.md): Guide étape par étape - [Autorisation Huawei](https://documentation.onesignal.com/docs/fr/authorize-onesignal-to-send-huawei-push.md): Guide étape par étape pour connecter votre application Huawei à OneSignal pour les notifications push, incluant la configuration de PushKit, la configuration de la clé API et l'auto-classification optionnelle des messages de Huawei pour les applications avec des utilisateurs en Chine. ##### Référence SDK mobile - [Référence du SDK mobile](https://documentation.onesignal.com/docs/fr/mobile-sdk-reference.md): Référence API du SDK mobile OneSignal : initialisation, identité, abonnements, tags, permissions, in-app et Live Activities pour Android, iOS et plus. - [Extensions de service mobile](https://documentation.onesignal.com/docs/fr/service-extensions.md): Interceptez et personnalisez les push avant affichage sur iOS et Android : médias enrichis, réception confirmée et traitement en arrière-plan. - [Gestion de la barre de notifications](https://documentation.onesignal.com/docs/fr/managing-the-notification-tray.md): Comment les notifications push mobiles OneSignal se comportent dans la barre de notifications sur Android et iOS : gestion des clics et des rejets, notifications restaurées, badges, effacement des notifications par programmation et extensions de service. - [Charge utile OSNotification](https://documentation.onesignal.com/docs/fr/osnotification-payload.md): Référence pour l'objet OSNotification de OneSignal, incluant tous les champs de charge utile, les propriétés spécifiques Android et iOS, les données personnalisées et les actions de clic. - [iOS : Support des App Clips](https://documentation.onesignal.com/docs/fr/app-clip-support.md): Apprenez à activer et configurer les notifications push OneSignal dans les App Clips iOS. Couvre les étapes de configuration, les limitations et le support pour les expériences avancées comme Target-Content-ID. ##### Dépannage SDK mobile - [Dépannage du SDK mobile](https://documentation.onesignal.com/docs/fr/mobile-troubleshooting.md): Résolvez les problèmes courants du SDK mobile OneSignal, notamment les échecs de livraison push, les erreurs APNS et les problèmes de messagerie in-app sur iOS, Android et les frameworks cross-platform. - [Obtenir un journal de débogage](https://documentation.onesignal.com/docs/fr/capturing-a-debug-log.md): Apprenez à capturer des journaux de débogage détaillés de votre application mobile en utilisant le SDK OneSignal. Ce guide explique comment activer la journalisation détaillée, reproduire les problèmes et partager les journaux pour dépanner les problèmes de notifications push sur les plateformes And… #### SDK web - [Référence du SDK Web](https://documentation.onesignal.com/docs/fr/web-sdk-reference.md): Référence API complète du SDK Web OneSignal v16 : initialisation, login, propriétés utilisateur, abonnements push, invites slidedown et écouteurs d'événements. ##### Configuration SDK web - [Configuration du SDK Web](https://documentation.onesignal.com/docs/fr/web-sdk-setup.md): Ajoutez des notifications push web OneSignal à votre site web avec le SDK JavaScript, la configuration du service worker et la configuration du tableau de bord. - [Configuration du push web iOS](https://documentation.onesignal.com/docs/fr/web-push-for-ios.md): Guide complet pour activer les notifications push web sur les appareils iOS et iPadOS, incluant la configuration du fichier manifest, les stratégies d'intégration des utilisateurs et les meilleures pratiques d'implémentation pour Safari, Chrome et Edge. - [OneSignal service worker](https://documentation.onesignal.com/docs/fr/onesignal-service-worker.md): Configurez le fichier OneSignalSDKWorker.js pour que votre site web puisse recevoir et afficher des notifications push web via OneSignal. - [Push web par code personnalisé avec le SDK Web OneSignal](https://documentation.onesignal.com/docs/fr/web-push-custom-code-setup.md): Mettez en place les notifications push web OneSignal avec du code personnalisé : SDK JavaScript, service worker et initialisation sur votre site. - [Configuration de Google Tag Manager](https://documentation.onesignal.com/docs/fr/google-tag-manager.md): Ajoutez OneSignal Web Push à votre site web en utilisant Google Tag Manager (GTM), incluant la configuration du service worker, l'initialisation et la configuration sécurisée des balises. - [Configuration du SDK Web Angular](https://documentation.onesignal.com/docs/fr/angular-setup.md): Intégrez les notifications push Web OneSignal dans votre application Angular en utilisant le package onesignal-ngx. Apprenez à installer, configurer et dépanner les service workers pour fournir des notifications push fluides. - [Configuration ReactJS et NextJS](https://documentation.onesignal.com/docs/fr/react-js-setup.md): Apprenez à intégrer les notifications push OneSignal avec votre application web ReactJS ou NextJS, y compris l'initialisation, la configuration du service worker et le support TypeScript. - [Configuration du SDK Web Vue JS](https://documentation.onesignal.com/docs/fr/vue-js-setup.md): Intégrez les notifications push Web de OneSignal dans votre application Vue.js en utilisant le plugin onesignal-vue ou @onesignal/onesignal-vue3. Apprenez à installer, configurer et personnaliser les service workers pour une livraison push transparente. ##### Dépannage SDK web - [Dépannage du SDK Web](https://documentation.onesignal.com/docs/fr/troubleshooting-web-push.md): Dépannez les problèmes de Web Push OneSignal, y compris les erreurs de service worker, les non-concordances d'origine, les types MIME et les notifications non affichées. - [Effacer le cache et réinitialiser les autorisations push](https://documentation.onesignal.com/docs/fr/clearing-cache-and-resetting-push-permissions.md): Apprenez à réinitialiser les autorisations push du navigateur, les service workers et les données de site sur Chrome, Firefox et Safari pour garantir des environnements de test propres et résoudre les problèmes de notifications push web. - [Webhooks push web](https://documentation.onesignal.com/docs/fr/webhooks.md): Configurez des webhooks HTTP pour recevoir des notifications en temps réel lorsque les utilisateurs affichent, cliquent ou rejettent des notifications push web. Guide complet avec exemples pour la prise en charge des navigateurs Chrome, Firefox et Safari. #### Activités en direct - [Configuration développeur des Live Activities](https://documentation.onesignal.com/docs/fr/live-activities-developer-setup.md): Configurez les Live Activities iOS avec OneSignal pour afficher des mises à jour en temps réel sur l'écran de verrouillage et Dynamic Island. - [Configuration SDK Live Activity multiplateforme](https://documentation.onesignal.com/docs/fr/cross-platform-live-activity-setup.md): Ajoutez les Live Activities iOS à une app React Native, Flutter, Unity, Cordova ou .NET MAUI. Avec setupDefault, le SDK gère le cycle de vie ActivityKit. - [Notifications Live Update Android](https://documentation.onesignal.com/docs/fr/android-live-notifications.md): Créez des Live Updates Android avec le push OneSignal : un payload structuré et la Notification Service Extension actualisent une notification persistante. #### Configuration desktop et montre - [Configuration de l'application macOS](https://documentation.onesignal.com/docs/fr/macos-app-setup.md): Apprenez à intégrer OneSignal dans votre application macOS, que vous utilisiez Mac Catalyst ou l'accès direct à l'API. Guide étape par étape pour configurer les plateformes, installer le SDK et envoyer des notifications push. - [Configuration d'application Windows](https://documentation.onesignal.com/docs/fr/windows-app-setup.md): Guide complet pour intégrer les notifications push OneSignal dans votre application Universal Windows Platform (UWP) en utilisant le service de notification push Windows (WNS) et l'API REST de OneSignal - [Support de watchOS et Wear OS](https://documentation.onesignal.com/docs/fr/watchos-and-wear-os-support.md): Guide complet pour implémenter les notifications push OneSignal pour les applications autonomes Apple watchOS et Android Wear OS, incluant les instructions de configuration et l'intégration de l'API. ### Tutoriels #### Tutoriels - [Tutoriels et cas d'utilisation](https://documentation.onesignal.com/docs/fr/tutorials.md): Explorez des tutoriels étape par étape et des exemples de bonnes pratiques pour vous aider à implémenter les fonctionnalités OneSignal et à augmenter l'engagement, la rétention et les revenus. #### 🏢 Par secteur - [Stratégies pour le jeu vidéo](https://documentation.onesignal.com/docs/fr/gaming-industry.md): Hub de messagerie gaming : ID de joueurs, tags de cycle de vie, événements personnalisés, segments et playbooks Journeys pour jeux mobiles et live-service. - [Stratégies pour la finance et la fintech](https://documentation.onesignal.com/docs/fr/financial-fintech-industry.md): Hub de messagerie finance et fintech : ID utilisateur, tags KYC, événements personnalisés, segments et playbooks Journeys pour conformité et rétention. - [Stratégies pour l'information et les médias](https://documentation.onesignal.com/docs/fr/news-and-media-industry.md): Hub de messagerie médias : ID utilisateur, tags d'intérêt, événements de lecture, segments et playbooks Journeys pour conversion paywall et réengagement. #### 📈 Augmenter l'engagement et la rétention - [Tutoriel panier abandonné](https://documentation.onesignal.com/docs/fr/abandoned-cart.md): Récupérez les ventes perdues avec les notifications de panier abandonné en utilisant OneSignal en suivant l'activité du panier, en créant des segments ciblés et en envoyant des rappels opportuns avec les Journeys. - [Créer un fil d'activité](https://documentation.onesignal.com/docs/fr/create-an-activity-feed.md): Apprenez à créer un fil d'activité dans l'application en utilisant l'API REST de OneSignal, Event Streams ou la logique sur l'appareil pour suivre et afficher l'historique des notifications des utilisateurs. - [Confirmation de réservation et récupération de réservation abandonnée](https://documentation.onesignal.com/docs/fr/booking-confirmations.md): Utilisez les événements personnalisés, Journeys et Data Feeds pour envoyer des emails de confirmation de réservation ou de récupération basés sur l'état de la réservation en temps réel. - [Créer un carrousel d'onboarding piloté par boutons](https://documentation.onesignal.com/docs/fr/in-app-onboarding-carousel-tutorial.md): Créez un flux d'onboarding multi-étapes en utilisant des Messages In-App HTML avec navigation par boutons et fermeture automatique. - [Activité sociale](https://documentation.onesignal.com/docs/fr/social-activity.md): Envoyez des notifications push, email et SMS pour les likes, abonnements, messages directs et événements de jeu avec custom_data pour vos alertes. - [Cibler les anciennes versions d'application pour encourager les mises à jour](https://documentation.onesignal.com/docs/fr/app-version-update.md): Utilisez les messages in-app pour détecter les versions d'application obsolètes et inviter les utilisateurs à mettre à jour, avec des segments spécifiques à chaque plateforme pour iOS et Android. - [Obtenez plus d'avis sur l'app store](https://documentation.onesignal.com/docs/fr/example-app-store-review.md): Invitez les utilisateurs à évaluer votre application avec des messages in-app OneSignal et des invites d'avis natives iOS et Android, réduisant ainsi les frictions et améliorant les notes. - [Intégrer les utilisateurs avec des messages in-app de type bannière](https://documentation.onesignal.com/docs/fr/example-create-a-tutorial.md): Guidez les utilisateurs avec des messages in-app de type bannière contextuels en haut et en bas qui ne bloquent pas l'interface de votre application. #### 🔔 Délivrer des messages critiques ou urgents - [Messages transactionnels](https://documentation.onesignal.com/docs/fr/transactional-messages.md): Apprenez à envoyer des messages transactionnels tels que des OTP, des mises à jour de facturation et des rappels en utilisant l'API de OneSignal avec des données personnalisées via push, e-mail ou SMS. - [Messages de secours : Assurer la livraison sur tous les canaux](https://documentation.onesignal.com/docs/fr/push-fallback-method.md): Implémentez une stratégie de secours avec OneSignal pour garantir que les messages critiques sont livrés par email ou SMS lorsque les notifications push échouent. Apprenez à configurer la messagerie multi-canal en utilisant Journeys, les API et la segmentation pour un engagement utilisateur fiable. - [Messages basés sur la localisation](https://documentation.onesignal.com/docs/fr/location-triggered-event.md): Segmentez les utilisateurs par pays, coordonnées GPS ou géorepérage et envoyez des notifications push déclenchées par la localisation avec OneSignal. #### 🧠 Améliorer le ciblage et la personnalisation - [Taguer les utilisateurs par thème de page et source d'abonnement](https://documentation.onesignal.com/docs/fr/auto-segment-users-by-page-visit.md): Taguez les utilisateurs dans OneSignal en fonction des pages qu'ils visitent et de la page depuis laquelle ils s'abonnent aux notifications push, puis segmentez pour des campagnes ciblées. - [Demander les permissions de localisation avec les messages intégrés](https://documentation.onesignal.com/docs/fr/location-opt-in-prompt.md): Guidez les utilisateurs pour activer le suivi de localisation dans votre application mobile en utilisant une pré-invitation douce dans OneSignal avant de déclencher la demande de permission de localisation native Android ou iOS. - [Créer un sondage pour demander des retours](https://documentation.onesignal.com/docs/fr/example-create-a-survey.md): Créez un sondage in-app multi-pages à l'aide du carrousel, des actions au clic de bouton, des outcomes et des balises pour l'analyse et la segmentation. - [Cibler certains fabricants et appareils Android](https://documentation.onesignal.com/docs/fr/example-target-certain-android-manufacturers-and-devices.md): Identifiez et ciblez les appareils Android de fabricants connus pour bloquer les notifications push lorsque les applications sont balayées, et utilisez des messages in-app pour éduquer les utilisateurs sur l'activation des paramètres appropriés. #### 🛠️ Améliorer l'expérience utilisateur et l'intégration - [Configurer l'opt-in confirmé pour les e-mails](https://documentation.onesignal.com/docs/fr/double-opt-in-email.md): Découvrez comment implémenter un processus de double opt-in (opt-in confirmé) dans OneSignal en utilisant des balises, des segments et des Journeys pour améliorer l'engagement, la conformité et la qualité de la liste. - [Centre de préférences](https://documentation.onesignal.com/docs/fr/preference-center.md): Apprenez à implémenter un centre de préférences utilisateur personnalisé dans votre application ou site web en utilisant les API OneSignal pour gérer les sujets de notification, les fréquences, les canaux et les paramètres de confidentialité des données. - [Envoyer des messages de vérification, lien magique, OTP et double opt-in](https://documentation.onesignal.com/docs/fr/example-verification-magic-link-otp.md): Exemples de messages de vérification par e-mail et SMS utilisant OneSignal, y compris les mots de passe à usage unique, les liens magiques et les flux de double opt-in avec des modèles et des exemples d'API. - [iOS : Notifications push à carrousel d'images](https://documentation.onesignal.com/docs/fr/ios-image-carousel-push-notifications.md): Comment implémenter un carrousel d'images dans les notifications push iOS OneSignal en utilisant 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 - [Référence du SDK Serveur](https://documentation.onesignal.com/docs/fr/server-sdk-reference.md): Installez, configurez et utilisez les SDK serveur OneSignal pour envoyer des notifications push, des e-mails et des SMS depuis votre backend en Node.js, Python, Java, Go, PHP, Ruby, C# et 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)