Benutzer:innen-API löschen

Voraussetzungen

Sobald ein:e Benutzer:in gelöscht wurde, kann diese:r nicht wiederhergestellt werden. Gelöschte Benutzer:innen können nur in den folgenden Szenarien erneut Nachrichten empfangen:

  • Web: Löschen Sie die Browser-Cookies und kehren Sie anschließend auf Ihre Website zurück.
  • Mobile: Öffnen Sie die App erneut oder deinstallieren und installieren Sie die App, um das SDK neu zu initialisieren. Es wird empfohlen, in Ihrer App die neueste Version des SDK zu verwenden.

Empfehlungen vor der Löschung

  1. Tag- und Alias-Informationen abfragen: Nutzen Sie die Tag-Alias-API, um die aktuell an die zu löschende registration_id gebundenen Aliase und Tags abzufragen.

  2. Zielgruppe prüfen: Überprüfen Sie sorgfältig die zu löschende Zielgruppe.

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

Beschreibung der Benutzer:innen-Lösch-API

Diese API dient zum Löschen eines bestehenden Benutzers bzw. einer bestehenden Benutzerin (registration_id). Dabei werden alle zugehörigen Daten, gebundene Tags, Aliase, Geräteinformationen und Zeitzoneninformationen gelöscht. Die Löschung erfolgt asynchron.

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

Request-Parameter

Name Erforderlich Beschreibung
Registration ID Ja Die eindeutige Kennung des Geräts im Engagelab-System. Batch-Löschung wird nicht unterstützt.

Beispiel-Request

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

Beispiel-Antwort

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

Fehler-Antwort

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

            
Diesen Codeblock im schwebenden Fenster anzeigen
icon
Vertrieb kontaktieren