Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Leftover Deploy Pt. 1 - October 12, 2022 #4227

Merged
merged 5 commits into from
Oct 12, 2022
Merged

Leftover Deploy Pt. 1 - October 12, 2022 #4227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0454c08
Edits for Preference Center API docs
lydia-xie Oct 12, 2022
9741587
Update _docs/_api/endpoints/preference_center/post_create_preference_…
lydia-xie Oct 12, 2022
eefd174
Merge pull request #4222 from braze-inc/lx/pref_edits
bre-fitzgerald Oct 12, 2022
2ac1be3
Handbook fix
KellieHawks Oct 12, 2022
de8a396
Merge pull request #4226 from braze-inc/kh/ssshandbook3
KellieHawks Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions _docs/_api/endpoints/preference_center/post_create_preference_center.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,15 @@ Authorization: Bearer YOUR-REST-API-KEY

| Parameter | Required | Data Type | Description |
| --------- | ---------| --------- | ----------- |
|`name`| Required | String | The name of the preference center. |
|`name`| Required | String | The name of the preference center that meets the following requirements: <br>- Only contains letters, numbers, hyphens, and underscores <br>- Does not have spaces |
|`preference_center_page_html`| Required | String | The HTML for the preference center page. |
|`confirmation_page_html`| Required | String | The HTML for the confirmation page. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
The preference center name can't be edited once created.
{% endalert %}

### Liquid tags

Refer to the following Liquid tags that can be included in your HTML to generate a user's subscription state on the preference center page.
Expand All @@ -66,8 +70,8 @@ Refer to the following Liquid tags that can be included in your HTML to generate

| Liquid | Description |
| --------- | ---------|
|`{% form_field_name :email_global_state %}`| Indicates that a specific form input element corresponds to the user's global email susbcribed state. User's selection state should be "opted_in", "subscribed", or "unsubscribed" when the form is submitted with selection data for the global email subscribed state. If it's a checkbox, the user will either be "opted_in" or "unsubscribed". For a hidden input, the "subscribed" state will also be valid. |
|`{% form_field_name :subscription_group %}`| Indicates that a specific form input element corresponds to a given subscription group. User's selection state should be either "subscribed" or "unsubscribed" when the form is submitted with selection data for a specific subscription group. |
|`{% form_field_name :email_global_state %}`| Indicates that a specific form input element corresponds to the user's global email susbcribed state. The user's selection state should be "opted_in", "subscribed", or "unsubscribed" when the form is submitted with selection data for the global email subscribed state. If it's a checkbox, the user will either be "opted_in" or "unsubscribed". For a hidden input, the "subscribed" state will also be valid. |
|`{% form_field_name :subscription_group external_id %}`| Indicates that a specific form input element corresponds to a given subscription group. The user's selection state should be either "subscribed" or "unsubscribed" when the form is submitted with selection data for a specific subscription group. |
|`{{preference_center_submit_url}}`| Generates URL for form submission. |
{: .reset-td-br-1 .reset-td-br-2}

Expand All @@ -77,8 +81,8 @@ Refer to the following Liquid tags that can be included in your HTML to generate
{% raw %}
```
{
"preference_center_api_id": "8efc52aa-935e-42b7-bd6b-98f43bb9b0f1",
"liquid_tag": "{{ preference_center.${My Preference Center 2022-09-22} }}",
"preference_center_api_id": "preference_center_api_id_example",
"liquid_tag": "{{preference_center.${MyPreferenceCenter2022-09-22}}}",
"created_at": "2022-09-22T18:28:07+00:00",
"message": "success"
}
Expand Down
2 changes: 1 addition & 1 deletion _docs/_hidden/other/handbooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ permalink: /handbooks/
- [Support & Success Services Handbook FY'21 PDF][1]


[3]: {{site.baseurl}}/assets/download_file/Braze_Success_and_Support_Services_Handbook_23.pdf
[3]: {{site.baseurl}}/assets/download_file/Braze_Success_and_Support_Services_Handbook_23.pdf?2022-10-12
[2]: {{site.baseurl}}/assets/download_file/Braze_Success_and_Support_Services_Handbook_22.pdf
[1]: {{site.baseurl}}/assets/download_file/Braze_Success_and_Support_Services_Handbook_21.pdf
15 changes: 10 additions & 5 deletions _docs/_user_guide/message_building_by_channel/email/preference_center.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ channel:

# Creating a preference center via API

Setting up a preference center provides a one-stop shop for your users to edit their notification preferences with your [email messaging]({{site.baseurl}}/user_guide/message_building_by_channel/email/). By using the preference center Braze endpoints, you can directly edit the HTML of your preference center to align with your branding and to understand your users' preferences.
Setting up a preference center provides a one-stop shop for your users to edit their notification preferences with your [email messaging]({{site.baseurl}}/user_guide/message_building_by_channel/email/). By using the [Preference Center Braze endpoints]({{site.baseurl}}/api/endpoints/preference_center), you can directly edit the HTML of your preference center to align with your branding and to understand your users' preferences.

{% alert important %}
The Braze endpoints used to create a preference center are currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand All @@ -28,9 +28,9 @@ The Braze endpoints used to create a preference center are currently in early ac
## Step 1: Create a preference center via API

{% raw %}
Let's begin building a preference center using the [`/preference_center/v1`]({{site.baseurl}}/api/endpoints/preference_center/post_create_preference_center/) endpoint. To customize your preference center, you can include HTML that aligns with your branding for the `preference_center_page_html` field and `confirmation_page_html` field.
Let's begin building a preference center using the [`/preference_center/v1` endpoint][1]. To customize your preference center, you can include HTML that aligns with your branding for the `preference_center_page_html` field and `confirmation_page_html` field.

The [`/preference_center/v1/{preferenceCenterExternalId}/url/{userId}`]({{site.baseurl}}/api/endpoints/preference_center/get_create_url_preference_center/) endpoint allows you to grab the preference center URL for a specific user outside of an email that is sent through Braze.
The [`/preference_center/v1/{preferenceCenterExternalId}/url/{userId}` endpoint][2] allows you to grab the preference center URL for a specific user outside of an email that is sent through Braze.

## Step 2: Include in email campaign

Expand All @@ -43,8 +43,13 @@ Next, insert your preference center into your email campaign by pasting a combin

## Editing a preference center

You can edit and update your preference center by using the [`/preference_center/v1/{preferenceCenterExternalId}`]({{site.baseurl}}/api/endpoints/preference_center/put_update_preference_center/) endpoint.
You can edit and update your preference center by using the [`/preference_center/v1/{preferenceCenterExternalId}` endpoint][3].

## Identifying preference centers and details

To identify your preference centers, use the [`/preference_center/v1/{preferenceCenterExternalId}`]({{site.baseurl}}/api/endpoints/preference_center/get_view_details_preference_center/) endpoint to return related information such as the last updated timestamp, the preference center ID, and more.
To identify your preference centers, use the [`/preference_center/v1/{preferenceCenterExternalId}` endpoint][4] to return related information such as the last updated timestamp, the preference center ID, and more.

[1]: {{site.baseurl}}/api/endpoints/preference_center/post_create_preference_center/
[2]: {{site.baseurl}}/api/endpoints/preference_center/get_create_url_preference_center/
[3]: {{site.baseurl}}/api/endpoints/preference_center/put_update_preference_center/
[4]: {{site.baseurl}}/api/endpoints/preference_center/get_view_details_preference_center/