Update a preference center
put
/preference_center/v1/{preferenceCenterExternalId}
Use this endpoint to update a preference center.
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 10 requests per minute, per app group.
Request body
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
{
"name": "preference_center_name",
"preference_center_title": "string",
"preference_center_page_html": "string",
"confirmation_page_html": "string"
}
Request parameters
Parameter | Required | Data Type | Description |
---|---|---|---|
preference_center_page_html |
Required | String | The HTML for the preference center page. |
preference_center_title |
Optional | String | The title for the preference center and confirmation pages. If a title is not specified, the title of the pages will default to “Preference Center”. |
confirmation_page_html |
Required | String | The HTML for the confirmation page. |
state |
Optional | String | Choose active or draft . |
Request example
1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/preference_center/v1/{preferenceCenterExternalId}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
"name": "Example",
"preference_center_title": "Example Preference Center Title",
"preference_center_page_html": "HTML for preference center here",
"confirmation_page_html": "HTML here with a message to users here",
"state": "active"
}
'
Response example
1
2
3
4
5
6
{
"preference_center_api_id": "8efc52aa-935e-42b7-bd6b-98f43bb9b0f1",
"created_at": "2022-09-22T18:28:07Z",
"updated_at": "2022-09-22T18:32:07Z",
"message": "success"
}