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 demande. Une seule des adresses external_ids
, user_aliases
, braze_ids
, email_addresses
, ou phone_numbers
peut être incluse dans une seule demande.
Si vous avez un cas d’utilisation qui ne peut pas être résolu avec la suppression en bloc d’utilisateurs via l’API, contactez l’ équipe d’assistance de Braze pour obtenir de l’aide.
La suppression des profils utilisateur ne peut pas être annulée. Cette action supprimera définitivement les utilisateurs susceptibles de provoquer des écarts dans vos données. Pour en savoir plus sur ce qui se passe lorsque vous supprimez un profil utilisateur à l’aide de l’API, consultez notre documentation d’aide.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation users.delete
.
Limite de débit
We apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/alias/new
, /users/identify
, /users/merge
, and /users/alias/update
endpoints, as documented in API rate limits.
Corps de la demande
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 demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
external_ids |
Facultatif | Tableau de chaînes de caractères | Identifiants externes à supprimer. |
user_aliases |
Facultatif | Tableau d’objets Alias utilisateur | Alias utilisateur à supprimer. |
braze_ids |
Facultatif | Tableau de chaînes de caractères | Suppression des identifiants des utilisateurs de Braze. |
email_addresses |
Facultatif | Tableau de chaînes de caractères | Les e-mails des utilisateurs à supprimer. Pour plus d’informations, reportez-vous à la section Suppression d’utilisateurs par e-mail. |
phone_numbers |
Facultatif | Tableau de chaînes de caractères | Numéros de téléphone de l’utilisateur à supprimer. |
Suppression des utilisateurs par e-mail
Si un email
est spécifié comme identifiant, une valeur prioritization
supplémentaire est requise dans l’identifiant. Le prioritization
est un tableau ordonné et doit spécifier quel utilisateur supprimer si plusieurs utilisateurs sont trouvés. Cela signifie que la suppression des utilisateurs ne se produira pas si plus d’un utilisateur correspond à une priorisation.
Les valeurs autorisées pour le tableau sont les suivantes : identified
, unidentified
, most_recently_updated
. most_recently_updated
signifie que la priorité est accordée à l’utilisateur ayant effectué la dernière mise à jour.
Une seule des options suivantes peut exister à la fois dans le tableau de priorisation :
identified
Il s’agit de donner la priorité à un utilisateur ayant uneexternal_id
unidentified
Il s’agit de donner la priorité à un utilisateur qui n’a pas deexternal_id
Exemple de demande
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
4
5
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
"deleted" : (required, integer) number of user IDs queued for deletion
}