Supprimer les utilisateurs

Utilisez cet endpoint pour supprimer un profil utilisateur en spécifiant un identifiant utilisateur connu.

Jusqu’à 50 external_ids, user_aliases, braze_ids, email_addresses ou phone_numbers peuvent être inclus dans une seule requête. Un seul type parmi external_ids, user_aliases, braze_ids, email_addresses ou phone_numbers peut être inclus dans une seule requête.

Si vous avez un cas d’utilisation qui ne peut pas être résolu par la suppression en bloc d’utilisateurs via l’API, contactez l’équipe d’assistance Braze pour obtenir de l’aide.

Conditions préalables

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

Limite de débit

Nous appliquons une limite de débit partagée de 20 000 requêtes par minute à cet endpoint. Cette limite de débit est partagée avec les endpoints /users/alias/new, /users/identify, /users/merge et /users/alias/update, comme documenté dans Limites de débit de l’API.

Corps de la requête

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
{
  "external_ids" : (optional, array of string) External IDs to be deleted,
  "user_aliases" : (optional, array of user alias objects) User aliases to be deleted,
  "braze_ids" : (optional, array of string) Braze user identifiers to be deleted,
  "email_addresses": (optional, array of string) User emails to be deleted,
  "phone_numbers": (optional, array of string) User phone numbers to be deleted
}

Paramètres de requête

Suppression d’utilisateurs par adresses e-mail et numéros de téléphone

Si une adresse e-mail ou un numéro de téléphone est spécifié comme identifiant, une valeur supplémentaire prioritization est requise dans l’identifiant. prioritization doit être un tableau ordonné qui spécifie quel utilisateur supprimer lorsque plusieurs utilisateurs correspondent. La suppression n’aura donc pas lieu si plus d’un utilisateur correspond à une priorisation donnée.

Les valeurs autorisées pour le tableau sont les suivantes :

• identified
• unidentified
• most_recently_updated (donne la priorité à l’utilisateur mis à jour le plus récemment)

Une seule des options suivantes peut figurer à la fois dans le tableau prioritization :

• identified donne la priorité à un utilisateur possédant un external_id
• unidentified donne la priorité à un utilisateur ne possédant pas d’external_id

Exemple de requête

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
curl --location --request POST 'https://rest.iad-01.braze.com/users/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "external_ids": ["external_identifier1", "external_identifier2"],
  "braze_ids": ["braze_identifier1", "braze_identifier2"],
  "user_aliases": [
    {
      "alias_name": "user_alias1", "alias_label": "alias_label1"
    },
    {
      "alias_name": "user_alias2", "alias_label": "alias_label2"
    }
  ],
  "email_addresses": [
    {
      "email": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

Réponse

1
2
3
{
  "deleted" : (required, integer) number of user IDs queued for deletion
}

Résolution des problèmes

Une réponse de succès a été renvoyée mais l’utilisateur apparaît toujours

Une réponse réussie confirme que la requête a été mise en file d’attente, et non que la suppression est terminée. La suppression s’effectue généralement en moins d’une seconde, mais la propagation à travers tous les caches peut prendre jusqu’à cinq minutes. Si vous recherchez immédiatement l’utilisateur dans le tableau de bord ou exportez ses données via l’API, il est possible que des résultats apparaissent encore pendant cette fenêtre de propagation.

Si l’utilisateur existe toujours après plusieurs minutes, vérifiez que l’identifiant de votre requête correspond bien au profil réel de l’utilisateur :

• Tableau external_ids : Confirmez que chaque valeur correspond exactement à l’ID externe d’un utilisateur.
• braze_id : Vous pouvez trouver le braze_id d’un utilisateur en exportant ses données avec l’endpoint /users/export/ids ou en exportant un segment au format CSV (où le braze_id apparaît sous le nom « Appboy ID »).
• Profils avec alias uniquement ou e-mail uniquement : Si le profil ne possède pas d’external_id, créez un segment filtrant sur L’ID utilisateur externe est vide combiné avec l’adresse e-mail ou le numéro de téléphone connu, puis exportez au format CSV pour récupérer le braze_id.

Pour confirmer qu’un utilisateur a bien été supprimé, appelez l’endpoint /users/export/ids en utilisant le même type d’identifiant que celui utilisé dans la requête de suppression (par exemple, en incluant la valeur dans external_ids, braze_id ou user_aliases). Si l’utilisateur n’existe plus, la réponse contient "users": [] et peut inclure "invalid_user_ids" listant cet identifiant.