Remover ID externo

Use este endpoint para remover os antigos IDs externos obsoletos de seus usuários.

Você pode enviar até 50 IDs externos por solicitação.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão users.external_ids.remove.

Limite de taxa

Corpo da solicitação

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 solicitação

Exemplo de solicitação

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

Resposta

A resposta confirmará todas as remoções bem-sucedidas, bem como as remoções malsucedidas com os erros associados. Mensagens de erro no campo removal_errors farão referência ao índice no vetor da solicitação 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>
}

O campo message retornará success para qualquer solicitação válida. Erros mais específicos são capturados no array removal_errors. O campo message retorna um erro no caso de:

• Chave de API inválida
• Array external_ids vazio
• external_ids array com mais de 50 itens
• Limite de frequência atingido (mais de 1.000 solicitações/minuto)