Eliminar ID externo

Utiliza este punto de conexión para eliminar los antiguos ID externos obsoletos de tus usuarios.

Puedes enviar hasta 50 ID externos por solicitud.

Advertencia

Este punto de conexión elimina completamente el ID obsoleto y no puede deshacerse. Si utilizas este punto de conexión para eliminar los external_ids obsoletos que todavía están asociados a usuarios de tu sistema, puedes impedir permanentemente que encuentres los datos de esos usuarios.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso users.external_ids.remove.

Límite de velocidad

Aplicamos un límite de velocidad de 1000 solicitudes por minuto a este punto de conexión, como se documenta en Límites de velocidad de la API.

Cuerpo de la solicitud

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

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

Parámetros de la solicitud

Ejemplo de solicitud

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

Importante

Solo se pueden eliminar los ID obsoletos; si se intenta eliminar un ID externo primario se producirá un error.

Respuesta

La respuesta confirmará todas las eliminaciones realizadas con éxito, así como las eliminaciones fallidas con los errores asociados. Los mensajes de error del campo removal_errors harán referencia al índice de la matriz de la solicitud original.

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

El campo message devolverá success para cualquier solicitud válida. Los errores más específicos se recogen en la matriz removal_errors. El campo message devuelve un error en caso de:

• Clave de API no válida
• Matriz external_ids vacía
• Matriz external_ids con más de 50 elementos
• Límite de velocidad alcanzado (más de 1000 solicitudes/minuto)