Braze API Guide
Braze provides a high-performance REST API to allow you to track users, send messages, export data, and more. This page lists available Braze API endpoints and their uses.
Endpoint
Description
Supprimer un champ d'un catalogue.
Créez plusieurs champs dans un catalogue.
Supprimer plusieurs objets dans votre catalogue.
Éditer plusieurs objets dans votre catalogue.
Créer plusieurs objets dans votre catalogue.
Retourner plusieurs produits du catalogue et leur contenu.
Mettre à jour plusieurs produits dans un catalogue.
Lister un produit du catalogue et ses détails.
Créer un produit dans un catalogue.
Éditer un produit dans un catalogue.
Supprimer un produit dans un catalogue.
Mettre à jour un produit dans un catalogue.
Supprimer un catalogue.
Créer un catalogue.
Lister les catalogues d'un espace de travail.
Supprimer une sélection de catalogue.
Créer une sélection dans un catalogue.
Renvoyez une liste des intégrations existantes.
Retourne une liste des états de synchronisation.
Déclencher une synchronisation pour une intégration donnée.
Extraire une liste d’adresses e-mail qui ont rejeté définitivement vos e-mails au cours d'une certaine période.
Renvoie les adresses mail qui se sont désabonnées entre
start_date to end_date.
Désinscrire un utilisateur des e-mails et le marquer comme rejeté définitivement.
Définir l’état de l’abonnement aux e-mails de vos utilisateurs.
Supprimer les adresses e-mail de votre liste de rejets Braze.
Supprimer les adresses e-mail de votre liste de courriers indésirables de Braze.
Récupérer une série quotidienne de diverses statistiques pour une campagne au fil du temps.
Récupérer des informations pertinentes d’une campagne donnée.
Exporter une liste de campagnes, comportant pour chacune son nom, s’il s’agit d’une campagne par API, son identifiant API éventuel et les balises qui lui sont associées.
Récupérer une série quotidienne de diverses statistiques pour un suivi.
send_id.
Exporter les données d’une série de dates pour un Canvas.
Exporter des cumuls de données de série temporelles pour un Canvas, fournissant ainsi un résumé concis des résultats du Canvas.
Exporter des métadonnées sur un Canvas, telles que le nom, l’heure de création, l’état actuel, etc.
Exporter une liste de Canvas, y compris le nom, l’identifiant de l’API Canvas et les balises associées.
Exportez une liste d'attributs personnalisés comprenant le nom, la description, le type de données, la longueur du tableau (le cas échéant), l'état et les tags associés.
Exportez une liste de noms d'événements personnalisés qui ont été enregistrés pour votre appli.
Récupérer une série du nombre d’occurrences d’un événement personnalisé dans votre application sur une période donnée.
Exportez une liste d'événements personnalisés comprenant le nom, la description, l'état, les tags associés et l'inclusion dans le rapport d'analyse.
Récupérer une série quotidienne du nombre total de nouveaux utilisateurs à chaque date.
Récupérer une série quotidienne du nombre total d’utilisateurs actifs uniques à chaque date.
Récupérer une série quotidienne du nombre total d’utilisateurs actifs uniques sur une période de 30 jours glissants.
Récupérer une série quotidienne du nombre total de désinstallations à chaque date.
Récupérer une série quotidienne de statistiques d’engagement pour une carte au fil du temps.
Récupérer les informations pertinentes sur une carte.
Exporter une liste de cartes de fil d’actualité, chacune incluant son nom et son identifiant API de carte.
Retourner des listes paginées des ID de produits.
Renvoyez le nombre total d'achats effectués dans votre application sur une période donnée.
Renvoyez le montant total dépensé dans votre application sur une période donnée.
Exporter une liste de segments, chacun incluant son nom, l’identifiant API du segment et s’il a un suivi des analyses activé.
Récupérer une série quotidienne de la taille estimée d’un segment au fil du temps.
Récupérer les informations pertinentes sur un segment.
Récupérer une série du nombre de sessions de votre application sur une période donnée.
Exporter tous les utilisateurs d’un Groupe de contrôle global.
Exporter des données à partir de n’importe quel profil utilisateur en spécifiant un identifiant utilisateur.
Exporter tous les utilisateurs d’un segment.
Mettre à jour une activité iOS Live.
Renvoyer une liste JSON d’informations sur les campagnes planifiées et les entrées Canvas entre maintenant et une date désignée
end_time spécifié dans la demande.
Annuler un message que vous avez déjà planifié avant qu’il ne soit envoyé.
Annuler un message Canvas que vous avez déjà planifié dans des campagnes déclenchées par API avant qu’il ne soit envoyé.
Annuler des messages de campagne déclenchés par API que vous avez déjà planifiés avant qu’ils ne soient envoyés.
Planifiez l'envoi d'une campagne, d'un canvas ou d'un autre message à un moment donné.
Envoyez des messages de campagne créés dans le tableau de bord par le biais d'une réception/distribution déclenchée par l'API.
Planifiez les messages Canvas par le biais d'une réception/distribution déclenchée par l'API.
Mettre à jour les messages planifiés. Cet endpoint accepte les mises à jour vers le
schedule ou messages paramètre ou les deux.
Mettre à jour des campagnes déclenchées par API planifiées créées dans le tableau de bord.
Mettre à jour des Canvas déclenchés par API planifiés qui ont été créés dans le tableau de bord.
Pour créer des ID d’envoi pouvant être utilisés pour envoyer des messages et suivre leur performance de manière programmatique sans créer une campagne pour chaque envoi.
Envoyez des messages immédiats et ponctuels à des utilisateurs désignés via l'API de Braze.
Envoyez des messages transactionnels immédiats et ponctuels à un utilisateur désigné.
Envoyez des messages immédiats et ponctuels à des utilisateurs désignés grâce à la réception/distribution déclenchée par l'API. - Envoyer des messages
Envoyez des messages canvas par le biais d'une réception/distribution déclenchée par l'API. - Envoyer des messages
Créer une URL pour un centre de préférences.
Répertorie les centres de préférences disponibles.
Afficher les détails de vos centres de préférences, y compris la date de leur création et de leurs mises à jour.
Mettre à jour un centre de préférences.
Créer un centre de préférences pour permettre aux utilisateurs de gérer leurs préférences de notification pour les campagnes par e-mail.
Extraire une liste des numéros de téléphone considérés comme « non valides » dans un certain délai.
Supprimez les numéros de téléphone "non valides" de la liste des numéros non valides dans Braze. Cela peut être utilisé pour revalider les numéros de téléphone après avoir été marqués comme non valides.
Obtenir le statut d’abonnement d’un utilisateur dans un groupe d’abonnement.
Répertorier et obtenir les groupes d’abonnement d’un certain utilisateur.
Mettre à jour des statuts d’abonnement par lots de 50 utilisateurs maximum sur le tableau de bord de Braze.
Mettre à jour des statuts d’abonnement par lots de 50 utilisateurs maximum sur le tableau de bord de Braze.
Répertorier les informations existantes de vos blocs de contenu.
Appeler les informations de vos blocs de contenu d’e-mail existants.
Créer un bloc de contenu d’e-mail.
Mettre à jour un bloc de contenu d’e-mail.
Obtenir une liste des e-mails disponibles sur votre compte Braze.
Obtenir des informations sur vos modèles d’e-mail.
Créer des modèles d’e-mail sur le tableau de bord de Braze.
Mettre à jour des modèles d’e-mail sur le tableau de bord de Braze.
Supprimer les anciens ID externes obsolètes de vos utilisateurs.
Renommer les ID externes de vos utilisateurs.
Ajouter de nouveaux alias utilisateur pour les utilisateurs identifiés existants, ou pour créer de nouveaux utilisateurs non identifiés.
Supprimer un profil utilisateur en spécifiant un identifiant utilisateur connu.
Identifier un utilisateur non identifié (alias uniquement).
Enregistrer des événements personnalisés, des achats et mettre à jour les attributs de profil utilisateur.
Mettre à jour les noms d’alias d’utilisateur existants avec les nouveaux noms d’alias d’utilisateur.
Fusionner un profil utilisateur avec un autre.
Rechercher un compte utilisateur du tableau de bord existant en spécifiant leur e-mail.
Rechercher un compte utilisateur du tableau de bord existant en spécifiant leur e-mail.
Mettez à jour un compte utilisateur de tableau de bord existant en spécifiant l'e-mail, les noms et prénoms, les autorisations (pour définir les autorisations au niveau de l'entreprise, de l'espace de travail et de l'équipe).
Supprimer définitivement un utilisateur du tableau de bord existant.
Créez un nouveau compte utilisateur pour le tableau de bord en indiquant l'e-mail, les noms et prénoms, les autorisations (pour définir les autorisations au niveau de l'entreprise, de l'espace de travail et de l'équipe).
Modifier cette page sur GitHub
CETTE PAGE A-T-ELLE ÉTÉ UTILE?
New Stuff!