logoDokumentation
Suchen

Benutzer-API löschen

Voraussetzung

Sobald ein Benutzer gelöscht wurde, kann dieser nicht wiederhergestellt werden. Gelöschte Benutzer können nur in den folgenden Szenarien wieder Nachrichten empfangen:

  • Web: Browser-Cookies löschen und anschließend die Website erneut aufrufen.
  • Mobile: Die App erneut öffnen oder die App deinstallieren und neu installieren, um das SDK neu zu initialisieren. Es wird empfohlen, stets die neueste Version des SDKs in Ihrer App zu verwenden.

Empfehlungen vor dem Löschen

  1. Tag- und Alias-Informationen abfragen: Nutzen Sie die Tag-Alias-API, um die aktuell mit der zu löschenden registration_id verknüpften Aliase und Tags abzufragen.

  2. Zielgruppe prüfen: Überprüfen Sie sorgfältig, welche Zielgruppe gelöscht werden soll.

    ❗️Warnung: Löschen Sie niemals sämtliche Benutzerkonten! Gehen Sie bei diesen Schritten äußerst vorsichtig vor, um sicherzustellen, dass nicht versehentlich alle Benutzer gelöscht werden.

Beschreibung der Benutzer-Lösch-API

Diese API wird verwendet, um einen bestehenden Benutzer (registration_id) zu löschen. Dabei werden alle zugehörigen Daten, verknüpfte Tags, Aliase, Geräteinformationen und Zeitzoneninformationen entfernt. Die Löschung wird asynchron durchgeführt.

Endpoint

DELETE /v4/devices/{registration_id}
              
              DELETE /v4/devices/{registration_id}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Request Header

DELETE /v4/devices/{registration_id} Authorization: Basic (base64 auth string) Accept: application/json
              
              DELETE /v4/devices/{registration_id}
Authorization: Basic (base64 auth string)
Accept: application/json

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Name Erforderlich Beschreibung
Registration ID Ja Die eindeutige Kennung des Geräts im EngageLab-System. Das gleichzeitige Löschen mehrerer IDs wird nicht unterstützt.

Beispielanfrage

DELETE /v4/devices/abc123 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l Accept: application/json
              
              DELETE /v4/devices/abc123
Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
Accept: application/json

            
Diesen Codeblock im schwebenden Fenster anzeigen

Beispielantwort

Erfolgreiche Antwort

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "success": true }
              
              HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8
{
  "success": true
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

{ "error":{ "code":27002, "message":"unbekannter Fehler" } }
              
              {
  "error":{
    "code":27002, 
    "message":"unbekannter Fehler"
    }
}

            
Diesen Codeblock im schwebenden Fenster anzeigen
icon
Vertrieb kontaktieren