Skip to content

Gerar URL da Central de Preferências

get

/preference_center/v1/{preferenceCenterExternalID}/url/{userID}

Use esse endpoint para gerar uma URL para uma Central de Preferências.

Cada URL da Central de Preferências é exclusiva para cada usuário.

See me in Postman

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão preference_center.user.get.

Limite de taxa

Esse endpoint tem um limite de taxa de 1.000 solicitações por minuto, por espaço de trabalho, conforme documentado em Limites de taxa da API.

Esse limite de taxa é fixo e não é configurável.

Parâmetros de caminho

Parâmetro Obrigatório Tipo de dados Descrição
preferenceCenterExternalID Obrigatório String O ID da sua Central de Preferências.
userID Obrigatório String O ID do usuário.

Parâmetros de solicitação

Parâmetro Obrigatório Tipo de dados Descrição
preference_center_api_id Obrigatório String O ID da sua Central de Preferências.
external_id Obrigatório String O ID externo de um usuário.

Exemplo de solicitação

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/preference_center/v1/$preference_center_external_id/url/$user_external_id' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'

Resposta

1
2
3

{
  "preference_center_url": "https://www.example.com/preferences"
}
New Stuff!