Skip to content

Braze API-Leitfaden

Braze bietet eine leistungsstarke REST API, mit der Sie Nutzer:innen verfolgen, Nachrichten versenden, Daten exportieren und vieles mehr können. Auf dieser Seite sind die verfügbaren Braze-API-Endpunkte und ihre Verwendungszwecke aufgeführt.

Endpunktsuche Results update automatically as you type.
Wählen Sie den Endpunkttyp aus, um das Glossar einzugrenzen:
Endpoint
Description
Die Push-Zugangsdaten für eine einzelne App aktualisieren.
Ein Feld aus einem Katalog löschen.
Mehrere Felder in einem Katalog erstellen.
Mehrere Artikel in Ihrem Katalog löschen.
Mehrere Artikel in Ihrem Katalog bearbeiten.
Mehrere Artikel in Ihrem Katalog erstellen.
Mehrere Artikel in einem Katalog ersetzen.
Einen Artikel in einem Katalog löschen.
Einen Katalogartikel und seine Details auflisten.
Mehrere Katalogartikel und deren Inhalt zurückgeben.
Einen Artikel in einem Katalog bearbeiten.
Einen Artikel in einem Katalog erstellen.
Einen Artikel in einem Katalog ersetzen.
Einen Katalog löschen.
Die Kataloge in einem Workspace auflisten.
Einen Katalog erstellen.
Eine Auswahl in einem Katalog erstellen.
Eine Liste vorhandener Integrationen zurückgeben.
Eine Liste der Synchronisierungsstatus zurückgeben.
Eine Synchronisierung für eine bestimmte Integration triggern.
Eine Liste der E-Mail-Adressen abrufen, die Ihre E-Mail-Nachrichten innerhalb eines bestimmten Zeitraums als Hard Bounce zurückgewiesen haben.
E-Mails zurückgeben, die sich im Zeitraum von start_date bis end_date abgemeldet haben.
Nutzer:innen von E-Mails abmelden und als Hard Bounce markieren.
Den E-Mail-Abo-Status für Ihre Nutzer:innen festlegen.
E-Mail-Adressen aus Ihrer Braze-Bounce-Liste entfernen.
E-Mail-Adressen aus Ihrer Braze-Spam-Liste entfernen.
Eine tägliche Reihe verschiedener Statistiken für eine Campaign über einen Zeitraum abrufen.
Relevante Informationen zu einer bestimmten Campaign abrufen.
Eine Liste von Campaigns exportieren, die jeweils den Namen, den Campaign-API-Bezeichner, die Angabe, ob es sich um eine API-Campaign handelt, sowie die zugehörigen Tags enthält.
Eine tägliche Reihe verschiedener Statistiken für eine getrackte send_id abrufen.
Zeitreihendaten für ein Canvas exportieren.
Rollups von Zeitreihendaten für ein Canvas exportieren und eine übersichtliche Zusammenfassung der Canvas-Ergebnisse bereitstellen.
Metadaten zu einem Canvas exportieren, z. B. den Namen, den Erstellungszeitpunkt, den aktuellen Status und mehr.
Eine Liste von Canvases exportieren, einschließlich des Namens, des Canvas-API-Bezeichners und der zugehörigen Tags.
Eine Liste angepasster Attribute exportieren, einschließlich Name, Beschreibung, Datentyp, Array-Länge (falls zutreffend), Status und zugehörige Tags.
Eine Liste der Namen angepasster Events exportieren, die für Ihre App aufgezeichnet wurden.
Eine Reihe der Vorkommen eines angepassten Events in Ihrer App über einen bestimmten Zeitraum abrufen.
Eine Liste angepasster Events exportieren, einschließlich Name, Beschreibung, Status, zugehörige Tags und Einbeziehung in Analytics-Berichte.
Eine tägliche Reihe der Gesamtzahl neuer Nutzer:innen an jedem Datum abrufen.
Eine tägliche Reihe der Gesamtzahl eindeutiger aktiver Nutzer:innen an jedem Datum abrufen.
Eine tägliche Reihe der Gesamtzahl eindeutiger aktiver Nutzer:innen über ein rollierendes 30-Tage-Fenster abrufen.
Eine tägliche Reihe der Gesamtzahl der Deinstallationen an jedem Datum abrufen.
Eine paginierte Liste von Produkt-IDs zurückgeben.
Die Gesamtzahl der Käufe in Ihrer App über einen Zeitraum zurückgeben.
Den Gesamtbetrag zurückgeben, der in Ihrer App über einen Zeitraum ausgegeben wurde.
Eine Liste von Segmenten exportieren, die jeweils den Namen, den Segment-API-Bezeichner und die Angabe enthalten, ob Analytics-Tracking aktiviert ist.
Eine tägliche Reihe der geschätzten Größe eines Segments über einen Zeitraum abrufen.
Relevante Informationen zu einem Segment abrufen.
Exporte für die angegebene Segment-ID stornieren.
Eine Reihe der Anzahl von Sitzungen für Ihre App über einen bestimmten Zeitraum abrufen.
Alle Nutzer:innen innerhalb einer globalen Kontrollgruppe exportieren.
Daten aus einem beliebigen Nutzerprofil exportieren, indem ein Nutzer-Bezeichner angegeben wird.
Alle Nutzer:innen innerhalb eines Segments exportieren.
Ein Asset in die Medienbibliothek hochladen.
Eine iOS-Live-Aktivität aktualisieren.
Eine JSON-Liste mit Informationen über geplante Campaigns und Entry-Canvases zwischen jetzt und einer in der Anfrage angegebenen end_time zurückgeben.
Eine zuvor geplante Nachricht stornieren, bevor sie gesendet wurde.
Eine zuvor über API getriggerte geplante Canvas-Nachricht stornieren, bevor sie gesendet wurde.
Zuvor geplante API-getriggerte Campaign-Nachrichten stornieren, bevor sie gesendet wurden.
Eine Campaign, ein Canvas oder eine andere Nachricht planen, die zu einem bestimmten Zeitpunkt gesendet werden soll.
Im Dashboard erstellte Campaign-Nachrichten über API-getriggerte Zustellung senden.
Canvas-Nachrichten über API-getriggerte Zustellung planen.
Geplante Nachrichten aktualisieren. Dieser Endpunkt akzeptiert Updates entweder für den schedule- oder messages-Parameter oder für beide.
Im Dashboard erstellte geplante API-getriggerte Campaigns aktualisieren.
Im Dashboard erstellte geplante API-getriggerte Canvases aktualisieren.
Sende-IDs erstellen, um Nachrichten zu versenden und die Performance der Nachrichten programmgesteuert zu verfolgen, ohne für jeden Versand eine Campaign erstellen zu müssen.
Sofortige, einmalige Nachrichten an bestimmte Nutzer:innen über die Braze-API senden.
Sofortige, einmalige transaktionsbezogene Nachrichten an bestimmte Nutzer:innen senden.
Sofortige, einmalige Nachrichten an bestimmte Nutzer:innen über API-getriggerte Zustellung senden.
Canvas-Nachrichten über API-getriggerte Zustellung senden.
Eine URL für ein Präferenzzentrum erstellen.
Verfügbare Präferenzzentren auflisten.
Die Details Ihres Präferenzzentrums anzeigen, einschließlich des Erstellungs- und Aktualisierungszeitpunkts.
Ein Präferenzzentrum erstellen, mit dem Nutzer:innen ihre Benachrichtigungspräferenzen für E-Mail-Campaigns verwalten können.
Ein Präferenzzentrum aktualisieren.
Einen SDK-Authentifizierungsschlüssel für Ihre App löschen.
SDK-Authentifizierungsschlüssel für Ihre App auflisten.
Einen neuen SDK-Authentifizierungsschlüssel für Ihre App erstellen.
Einen SDK-Authentifizierungsschlüssel als Primärschlüssel für Ihre App festlegen.
Eine Liste der Telefonnummern abrufen, die Braze innerhalb eines bestimmten Zeitraums als „ungültig“ markiert hat.
„Ungültige“ Telefonnummern aus der Liste ungültiger Nummern in Braze entfernen. Verwenden Sie dies, um Telefonnummern erneut zu validieren, nachdem Braze sie als ungültig markiert hat.
Den Abo-Status von Nutzer:innen in einer Abo-Gruppe abrufen.
Die Abo-Gruppen bestimmter Nutzer:innen auflisten und abrufen.
Den Abo-Status von bis zu 50 Nutzer:innen im Braze-Dashboard per Batch aktualisieren.
Den Abo-Status von bis zu 50 Nutzer:innen im Braze-Dashboard per Batch aktualisieren.
Informationen zu Ihren bestehenden Content Blocks auflisten.
Informationen zu Ihrem bestehenden E-Mail-Content-Block abrufen.
Einen E-Mail-Content-Block erstellen.
Einen E-Mail-Content-Block aktualisieren.
Eine Liste der verfügbaren E-Mail-Templates in Ihrem Braze-Konto abrufen.
Informationen zu Ihren E-Mail-Templates abrufen.
E-Mail-Templates im Braze-Dashboard erstellen.
E-Mail-Templates im Braze-Dashboard aktualisieren.
Die alten, veralteten externen IDs Ihrer Nutzer:innen entfernen.
Die externen IDs Ihrer Nutzer:innen umbenennen.
Neue Nutzer-Aliase für bestehende identifizierte Nutzer:innen hinzufügen oder neue nicht identifizierte Nutzer:innen erstellen.
Ein beliebiges Nutzerprofil löschen, indem ein bekannter Nutzer-Bezeichner angegeben wird.
Nicht identifizierte Nutzer:innen (nur Alias) identifizieren.
Angepasste Events und Käufe erfassen sowie Nutzerprofilattribute aktualisieren.
Bestehende Nutzer-Alias-Namen auf neue Nutzer-Alias-Namen aktualisieren.
Ein Nutzerprofil mit einem anderen zusammenführen.
Bestehende Dashboard-Nutzer:innen dauerhaft löschen.
Ein bestehendes Dashboard-Nutzer:innen-Konto anhand der E-Mail-Adresse nachschlagen.
Ein bestehendes Dashboard-Nutzer:innen-Konto anhand der Ressourcen-ID nachschlagen.
Ein neues Dashboard-Nutzer:innen-Konto erstellen, indem E-Mail, Vor- und Nachname sowie Berechtigungen (für die Festlegung von Berechtigungen auf Unternehmens-, Workspace- und Teamebene) angegeben werden.
Ein bestehendes Dashboard-Nutzer:innen-Konto aktualisieren, indem E-Mail, Vor- und Nachname sowie Berechtigungen (für die Festlegung von Berechtigungen auf Unternehmens-, Workspace- und Teamebene) angegeben werden.
New Stuff!