Gerar URL da Central de Preferências
get
/preference_center/v1/{preferenceCenterExternalID}/url/{userID}
Use esse endpoint para gerar um URL para uma Central de Preferências.
Cada URL da Central de Preferências é exclusivo para cada usuário.
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 frequência de 1.000 solicitações por minuto, por espaço de trabalho.
Parâmetros da jornada
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
preferenceCenterExternalID |
Obrigatória | String | A ID de sua central de preferências. |
userID |
Obrigatória | String | A ID do usuário. |
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
preference_center_api_id |
Obrigatória | String | A ID de sua central de preferências. |
external_id |
Obrigatória | String | A ID externa 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"
}
note:
Esse endpoint gera apenas URLs para o novo centro de preferências (como centros de preferências criados via API ou pelo editor de arrastar e soltar).
New Stuff!