Renomear ID externo
/users/external_ids/rename
Use esse endpoint para renomear os IDs externos dos seus usuários.
Você pode enviar até 50 objetos de renomeação por solicitação.
Esse endpoint define um novo external_id (primário) para o usuário e torna obsoleto o external_id existente. Isso significa que o usuário pode ser identificado por qualquer um dos dois external_id até que o obsoleto seja removido. Ter vários IDs externos permite um período de migração. Assim, as versões legadas dos seus apps que usam o esquema de nomenclatura de ID externo anterior continuam funcionando. O perfil permanece totalmente funcional com ambos os identificadores durante a janela de migração. O SDK da Braze, a REST API e os pipelines de envio de mensagens podem continuar referenciando o usuário por qualquer um dos IDs até que o obsoleto seja explicitamente removido.
Depois que o esquema de nomenclatura antigo não estiver mais em uso, recomendamos fortemente remover os IDs externos obsoletos usando o endpoint /users/external_ids/remove.

Remova os IDs externos obsoletos com o endpoint /users/external_ids/remove, e não com /users/delete. Enviar uma solicitação para /users/delete com o ID externo obsoleto exclui totalmente o perfil do usuário, e essa ação não pode ser desfeita.
Você pode baixar o documento OpenAPI e usá-lo para validar esquemas. Para saber como, consulte Usar esquemas OpenAPI para validação de solicitações.