Supprimer l’ID externe

Utilisez cet endpoint pour supprimer les anciens ID externes obsolètes de vos utilisateurs.

Vous pouvez envoyer jusqu’à 50 ID externes par demande.

Avertissement

Cet endpoint supprime complètement l’ID obsolète et cette action ne peut pas être annulée. Utiliser cet endpoint pour supprimer des external_ids obsolètes qui sont toujours associés à des utilisateurs dans votre système peut vous empêcher définitivement de retrouver les données de ces utilisateurs.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation users.external_ids.remove.

Limite de débit

Nous appliquons une limite de débit de 1 000 requêtes par minute à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la demande

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

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

Paramètres de demande

Exemple de demande

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",
    ...
  ]
}'

Important

Seuls les ID obsolètes peuvent être supprimés ; toute tentative de suppression d’un ID externe principal entraînera une erreur.

Réponse

La réponse confirmera toutes les suppressions réussies, ainsi que les suppressions échouées avec les erreurs associées. Les messages d’erreur dans le champ removal_errors feront référence à l’index dans le tableau de la demande d’origine.

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>
}

Le champ message renverra success pour toute demande valide. Des erreurs plus spécifiques sont capturées dans le tableau removal_errors. Le champ message renvoie une erreur dans les cas suivants :

• Clé API non valide
• Tableau external_ids vide
• Tableau external_ids avec plus de 50 éléments
• Limite de débit atteinte (plus de 1 000 requêtes/minute)