Externe ID entfernen

Verwenden Sie diesen Endpunkt, um die alten, veralteten externen IDs Ihrer Nutzer:innen zu entfernen.

Sie können bis zu 50 externe IDs pro Anfrage senden.

Warnung

Dieser Endpunkt löscht die veraltete ID vollständig und kann nicht rückgängig gemacht werden. Wenn Sie diesen Endpunkt verwenden, um veraltete external_ids zu entfernen, die noch mit Nutzer:innen in Ihrem System verbunden sind, können Sie die Daten dieser Nutzer:innen möglicherweise dauerhaft nicht mehr finden.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung users.external_ids.remove.

Rate-Limit

Für diesen Endpunkt gilt ein Rate-Limit von 1.000 Anfragen pro Minute, wie in API-Rate-Limits dokumentiert.

Anfragetext

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
{
  "external_ids" : (required, array of external identifiers to remove)
}

Anfrageparameter

Beispiel für eine Anfrage

1
2
3
4
5
6
7
8
9
curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/remove' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "external_ids" :[
    "existing_deprecated_external_id_string",
    ...
  ]
}'

Wichtig

Nur veraltete IDs können entfernt werden. Der Versuch, eine primäre externe ID zu entfernen, führt zu einem Fehler.

Antwort

Die Antwort bestätigt alle erfolgreichen Entfernungen sowie erfolglose Entfernungen mit den dazugehörigen Fehlern. Fehlermeldungen im Feld removal_errors referenzieren den Index im Array der ursprünglichen Anfrage.

1
2
3
4
5
{
  "message" : (string) status message,
  "removed_ids" : (array of strings) successful remove operations,
  "removal_errors": (array of arrays) <minor error message>
}

Das Feld message gibt für jede gültige Anfrage success zurück. Spezifischere Fehler werden im Array removal_errors erfasst. Das Feld message gibt einen Fehler zurück in folgenden Fällen:

• Ungültiger API-Schlüssel
• Leeres external_ids-Array
• external_ids-Array mit mehr als 50 Elementen
• Rate-Limit erreicht (mehr als 1.000 Anfragen/Minute)