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.
Prerequisites
To use this endpoint, you’ll need an API key with the preference_center.user.get permission.
Rate limit
This endpoint has a rate limit of 1,000 requests per minute, per workspace.
Path parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
preferenceCenterExternalID |
Required | String | The ID for your preference center. |
userID |
Required | String | The user ID. |
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. |
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'
Response
1
2
3
{
"preference_center_url": "https://www.example.com/preferences"
}
note:
This endpoint only generates URLs for the new preference center (such as preference centers created using our API or the drag-and-drop editor).
Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!