Skip to content

Actualizar centro de preferencias

put

/preference_center/v1/{preferenceCenterExternalID}

Utiliza este endpoint para actualizar un centro de preferencias.

See me in Postman

Requisitos previos

Para utilizar este endpoint, necesitarás una clave de API con el permiso preference_center.update.

Límite de velocidad

Parámetros de ruta

Parámetro Obligatorio Tipo de datos Descripción
preferenceCenterExternalID Obligatorio Cadena El ID de tu centro de preferencias.

Cuerpo de la solicitud

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)
      }
    ]
  }
}

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
preference_center_page_html Obligatorio Cadena El HTML de la página del centro de preferencias.
preference_center_title Opcional Cadena El título del centro de preferencias y las páginas de confirmación. Si no se especifica un título, el título de las páginas será por defecto “Preference Center”.
confirmation_page_html Obligatorio Cadena El HTML de la página de confirmación.
state Opcional Cadena Elige active o draft.
options Opcional Objeto Atributos:
meta-viewport-content: cuando esté presente, se añadirá una metaetiqueta viewport a la página con content= <value of attribute>.

link-tags: establece un favicon para la página. Cuando se establece, se añade a la página una etiqueta <link> con un atributo rel.

Ejemplo de solicitud

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"
}
'

Ejemplo de respuesta

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"
}
New Stuff!