Generate preference center URL
get
/preference_center/v1/{preferenceCenterExternalId}/url/{userId}
Use this endpoint to generate a URL for a preference center. Each preference center URL is unique to each user.
important:
Support for this endpoint is currently in early access. Contact your Braze account manager if you are interested in participating in the early access.
Rate limit
This endpoint has a rate limit of 1,000 requests per minute, per app group.
Example request
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'
Request parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
preference_center_api_id |
Required | String | The ID for your preference center. |
external_id |
Required | String | The external ID for a user. |
Response
1
2
3
{
"preference_center_url": "https://www.example.com/preferences"
}
Edit this page on GitHub