Eliminar ID externo

Utiliza este punto final para eliminar los antiguos ID externos obsoletos de tus usuarios.

Puedes enviar hasta 50 ID externos por solicitud.

Requisitos previos

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

Límite de velocidad

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

Respuesta

La respuesta confirmará todas las retiradas realizadas con éxito, así como las retiradas 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 vacía external_ids
• external_ids matriz con más de 50 elementos
• Alcanzado el límite de velocidad (más de 1.000 solicitudes/minuto)