Skip to content

Update des Präferenzzentrums

put

/preference_center/v1/{preferenceCenterExternalID}

Verwenden Sie diesen Endpunkt, um ein Präferenzzentrum zu aktualisieren.

See me in Postman

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung preference_center.update.

Rate-Limits

Dieser Endpunkt hat ein Rate-Limit von 10 Anfragen pro Minute und Workspace, wie in API-Rate-Limits dokumentiert.

Pfad-Parameter

Parameter Erforderlich Datentyp Beschreibung
preferenceCenterExternalID Erforderlich String Die ID für Ihr Präferenzzentrum.

Anfragetext

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

Anfrage-Parameter

Parameter Erforderlich Datentyp Beschreibung
preference_center_page_html Erforderlich String Der HTML-Code für die Seite des Präferenzzentrums.
preference_center_title Optional String Der Titel für das Präferenzzentrum und die Bestätigungsseiten. Wenn kein Titel angegeben wird, lautet der Standardtitel der Seiten „Preference Center“.
confirmation_page_html Erforderlich String Der HTML-Code für die Bestätigungsseite.
state Optional String Wählen Sie active oder draft.
options Optional Objekt Attribute:
meta-viewport-content: Wenn vorhanden, wird der Seite ein viewport-Meta-Tag mit content= <value of attribute> hinzugefügt.

link-tags: Legen Sie ein Favicon für die Seite fest. Wenn diese Option gesetzt ist, wird der Seite ein <link>-Tag mit einem rel-Attribut hinzugefügt.

Beispielanfrage

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

Beispielantwort

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!