Mettre à jour un centre de préférences
put
/preference_center/v1/{preferenceCenterExternalID}
Utilisez cet endpoint pour mettre à jour un centre de préférences.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation preference_center.update.
Limite de débit
Cet endpoint a une limitation du débit de 10 requêtes par minute, par espace de travail.
Paramètres de chemin
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
preferenceCenterExternalID |
Requis | Chaîne de caractères | L’ID de votre centre de préférences. |
Corps de la demande
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"name": "preference_center_name",
"preference_center_title": "string",
"preference_center_page_html": "string",
"confirmation_page_html": "string",
"options": {
"unknown macro": {links-tags}
"options": {
"meta-viewport-content": "string", (optional) Only the `content` value of the meta tag,
"links-tags": [
{
"rel": "string", (required) One of: "icon", "shortcut icon", or "apple-touch-icon",
"type": "string", (optional) Valid values: "image/png", "image/svg", "image/gif", "image/x-icon", "image/svg+xml", "mask-icon",
"sizes": "string", (optional),
"color": "string", (optional) Use when type="mask-icon",
"href": "string", (required)
}
]
}
}
Paramètres de demande
| Paramètre | Requis | Type de données | Description |
|---|---|---|---|
preference_center_page_html |
Requis | Chaîne de caractères | L’HTML de la page du centre de préférences. |
preference_center_title |
Facultatif | Chaîne de caractères | Le titre des pages du centre de préférences et de confirmation. Si aucun titre n’est précisé, le titre des pages passera par défaut à « Centre de préférences ». |
confirmation_page_html |
Requis | Chaîne de caractères | L’HTML de la page de confirmation. |
state |
Facultatif | Chaîne de caractères | Choisir active ou draft. |
options |
Facultatif | Objet | Attributs : meta-viewport-content : Le cas échéant, une étiquette méta viewport sera ajoutée à la page avec content= <value of attribute>.link-tags : Définissez un favicon pour la page. Lorsque cette option est activée, une étiquette <link> avec un attribut rel est ajoutée à la page. |
Exemple de demande
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"
}
'
Exemple de réponse
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"
}
Modifier cette page sur GitHub
CETTE PAGE A-T-ELLE ÉTÉ UTILE?
New Stuff!