Supprimer des ID externes

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

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

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

We apply a rate limit of 1,000 requests per minute to this endpoint, 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
{
  "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",
    ...
  ]
}'

Réponse

La réponse confirmera toutes les suppressions réussies et les suppressions infructueuses avec les erreurs associées. Les messages d’erreur dans le champ removal_errors référenceront 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 toutes les demandes valides. Des erreurs plus spécifiques sont saisies 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
• Atteinte de la limite de débit (plus de 1 000 requêtes/minute)