Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
ee3cb53
Initial plan
Copilot Dec 9, 2025
e5c6d47
Add note about global unsubscribe behavior for get_list_user_subscrip…
Copilot Dec 9, 2025
3a45970
Update _docs/_api/endpoints/subscription_groups/get_list_user_subscri…
lydia-xie Dec 15, 2025
0e5719e
Update _docs/_api/endpoints/subscription_groups/get_list_user_subscri…
lydia-xie Jan 6, 2026
d191e77
[BD-5536] Updates to wording from Legal
lydia-xie Jan 7, 2026
22a3983
Document global unsubscribe behavior in get_list_user_subscription_gr…
atom-evens Jan 7, 2026
15e59aa
Update _docs/_user_guide/message_building_by_channel/sms_mms_rcs/laws…
lydia-xie Jan 7, 2026
0c4e0fc
Update _docs/_user_guide/message_building_by_channel/sms_mms_rcs/laws…
lydia-xie Jan 7, 2026
df448f4
Updating docs for Currents v4 release (#11470)
ian-absher Jan 7, 2026
02ab144
[BD-5536] Updates to wording from Legal (#11479)
atom-evens Jan 7, 2026
b685e4d
backlink to translations (#11480)
davidbielik Jan 7, 2026
581d647
Revert "[BD-5528] Add alert for impact of default setting in Safari o…
lydia-xie Jan 7, 2026
2188a62
Update API settings documentation
bre-fitzgerald Jan 7, 2026
07875b7
Add related articles to API usage dashboard doc
bre-fitzgerald Jan 7, 2026
a6d5827
Update API settings documentation (#11483)
atom-evens Jan 7, 2026
e5535de
Add related articles to API usage dashboard doc (#11484)
atom-evens Jan 7, 2026
02fda1d
Update navigation step for Currents integration (#11482)
davidnelson-braze Jan 7, 2026
ba5ceb3
[BD-5531] Fix Liquid in example (#11475)
lydia-xie Jan 8, 2026
e8015f4
Update link for SDK data collection in user profiles (#11486)
bre-fitzgerald Jan 8, 2026
a9f5877
Updates for single-channel rate limiting — MERGE 1/8 (#11058)
lydia-xie Jan 8, 2026
3b0ef0c
translations headers (#11488)
davidbielik Jan 8, 2026
115a42e
[BD-5502] Update Message Usage dashboard and remove dupe includes (#1…
rachel-feinberg Jan 8, 2026
f55a5d7
[BD-5452] Banners in Canvas Message step EA — MERGE 1/8 (#11404)
lydia-xie Jan 8, 2026
28da1a3
[BD-5529] eCommerce Order Placed event type (#11474)
rachel-feinberg Jan 8, 2026
a5acc5f
[BD-5485] Update WhatsApp compliance [MERGE JANUARY 8] (#11344)
rachel-feinberg Jan 8, 2026
cb89a67
Export by all rows or rows with errors for sync logs (#11489)
lydia-xie Jan 8, 2026
7945f01
January 2026 release notes (#11481)
lydia-xie Jan 8, 2026
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
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,8 @@ All successful responses will return `Subscribed`, `Unsubscribed`, or `Unknown`
}
```

{% alert note %}
When a user unsubscribes globally, they are unsubscribed from each subscription group. This endpoint returns the last subscription status for each subscription group. This is expected behavior because if the user decides to globally resubscribe, Braze reverts each subscription status.
{% endalert %}

{% endapi %}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the campaign translation sourc
/campaigns/translations/source
{% endapimethod %}

> Use this endpoint to view all the default translation sources for a campaign's translation tags. These are the values with the {% raw %}`{% translation id %} source {% endtranslation %}`{% endraw %}
> Use this endpoint to view all the default translation sources for a campaign's translation tags. These are the values within the {% raw %}`{% translation id %} source {% endtranslation %}`{% endraw %}. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the View all translations for
/campaigns/translations
{% endapimethod %}

> Use this endpoint to view all the translations for each message variant in a campaign.
> Use this endpoint to view all the translations for each message variant in a campaign. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down Expand Up @@ -96,7 +96,7 @@ The status code `200` could return the following response header and body.

### Example error response

The status code `400` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter.
The status code `400` could return the following response body.

```json
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the Update translation in a ca
/campaigns/translations
{% endapimethod %}

> Use this endpoint to update multiple translations for a campaign.
> Use this endpoint to update multiple translations for a campaign. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

If you want to update translations after a campaign has been launched, you'll need to [save your message as a draft]({{site.baseurl}}/user_guide/engagement_tools/campaigns/managing_campaigns/change_your_campaign_after_launch/) first.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the Canvas translation source
/canvas/translations/source
{% endapimethod %}

> Use this endpoint to view all the default translation sources for a canvas's translation tags. These are the values with the {% raw %}`{% translation id %} source {% endtranslation %}`{% endraw %}
> Use this endpoint to view all the default translation sources for a canvas's translation tags. These are the values with the {% raw %}`{% translation id %} source {% endtranslation %}`{% endraw %}. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the View translation for a Can
/canvas/translations
{% endapimethod %}

> Use this endpoint to preview a translated message for a Canvas.
> Use this endpoint to preview a translated message for a Canvas. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the Update translation in a Ca
/canvas/translations
{% endapimethod %}

> Use this endpoint to update multiple translations for a Canvas.
> Use this endpoint to update multiple translations for a Canvas. See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

If you want to update translations after a Canvas has been launched, you'll need to [save your message as a draft]({{site.baseurl}}/post-launch_edits/) first.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the View source translations f
/templates/email/translations/source
{% endapimethod %}

> Use this endpoint to view the source translations for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates).
> Use this endpoint to view the source translations for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates). See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the View specific translation
/templates/translations/email
{% endapimethod %}

> Use this endpoint to view a specific translation and locale for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates).
> Use this endpoint to view a specific translation and locale for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates). See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the View all translations and
/templates/email/translations/
{% endapimethod %}

> Use this endpoint to view all translations and locales for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates).
> Use this endpoint to view all translations and locales for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates). See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the Update translations for an
/templates/email/translations/
{% endapimethod %}

> Use this endpoint to update translations for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates).
> Use this endpoint to update translations for an [email template]({{site.baseurl}}/user_guide/message_building_by_channel/email/templates). See [Locales in messages]({{site.baseurl}}/user_guide/engagement_tools/messaging_fundamentals/localization/locales/) for more information about translation features.

{% alert important %}
This endpoint is currently in early access. Contact your Braze account manager if you're interested in participating in the early access.
Expand Down
2 changes: 1 addition & 1 deletion _docs/_developer_guide/banners/placements.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ You can use custom properties from your Banner campaign to retrieve key–value

### Prerequisites

You'll need to [add custom properties]({{site.baseurl}}/user_guide/message_building_by_channel/banners/creating_campaigns/#custom-properties) to your Banner campaign. Additionally, these are the minimum SDK versions required to access custom properties:
You'll need to [add custom properties]({{site.baseurl}}/user_guide/message_building_by_channel/banners/create/#custom-properties) to your Banner campaign. Additionally, these are the minimum SDK versions required to access custom properties:

{% sdk_min_versions swift:13.1.0 android:38.0.0 web:6.1.0 reactnative:17.0.0 flutter:15.1.0 %}

Expand Down
8 changes: 4 additions & 4 deletions _docs/_developer_guide/banners/testing.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
nav_title: Test banners
article_title: Test banners
nav_title: Test Banners
article_title: Test Banners
page_order: 2
description: "Learn how to test your Banner message before launching your campaign so you can ensure all media, copy, personalization, and custom attributes render correctly."
channel:
- banners
noindex: true
---

# Test banners
# Test Banners

> Learn how to test your Banner message before launching your campaign so you can ensure all media, copy, personalization, and custom attributes render correctly. For more general information, see [About Banners]({{site.baseurl}}/developer_guide/banners).

## Prerequisites

Before you can test Banner messages in Braze, you'll need to create a [Banner campaign in Braze]({{site.baseurl}}/user_guide/message_building_by_channel/banners/creating_campaigns/). Additionally, verify that the placement you want to test is already [placed in your app or website]({{site.baseurl}}/developer_guide/banners/placements).
Before you can test Banner messages in Braze, you'll need to create a [Banner campaign in Braze]({{site.baseurl}}/user_guide/message_building_by_channel/banners/create/). Additionally, verify that the placement you want to test is already [placed in your app or website]({{site.baseurl}}/developer_guide/banners/placements).

To send a test to either [content test groups]({{site.baseurl}}/user_guide/administrative/app_settings/developer_console/internal_groups_tab/#content-test-groups) or individual users, push must be enabled on your test devices with valid push tokens registered for the test user before sending.

Expand Down
11 changes: 7 additions & 4 deletions _docs/_hidden/compliance/whatsapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,22 @@ noindex: true

# Compliance Documentation for WhatsApp Services ("WhatsApp Channel")

_Revision Date: 1 March 2024_
_Revision Date: 6 January 2026_

_(Effective as of the Revision Date; subject to change)_

The following additional terms apply in relation to Customer’s use of the WhatsApp Channel:
The following additional terms apply in relation to Customer’s use of the WhatsApp Channel:

## Applicable Third-Party Provider Terms

Customer shall comply with any prerequisites, terms, and policies applicable to the WhatsApp Channel, including any terms required by WhatsApp, LLC and its group affiliates, as described in the Braze [WhatsApp setup]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/overview/) page.

## Webhook Use Exception Terms
Customer may not use webhooks to trigger the sending of messages via the WhatsApp Channel unless it is for customer support purposes, such as human-assisted chat use cases and/or chatbot use cases.
## Bring Your Own (BYO) WhatsApp Connector

Customers can connect their direct WhatsApp accounts with Braze using the BYO WhatsApp Connector.

## General terms

Without limiting the generality of any Customer obligations under the Agreement, and for the avoidance of doubt, Customer shall be solely responsible for obtaining all necessary rights, consents, and authorizations and providing legally adequate privacy notices in connection with its use of this Channel and obtaining all legally required consents and authorizations for sending, or receiving as applicable, Messages through this Channel.

{% multi_lang_include braze_legal/english_language_governance.md %}
2 changes: 1 addition & 1 deletion _docs/_releases/2016.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.9
page_order: 2.0
nav_title: 2016
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2017.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.8
page_order: 1.9
nav_title: 2017
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2018.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.7
page_order: 1.8
nav_title: 2018
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2019.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.6
page_order: 1.7
nav_title: 2019
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2020.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.5
page_order: 1.6
nav_title: 2020
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2021.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.4
page_order: 1.5
nav_title: 2021
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2022.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.3
page_order: 1.4
nav_title: 2022
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2023.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.2
page_order: 1.3
nav_title: 2023
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2024.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.1
page_order: 1.2
nav_title: 2024
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2025.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
page_order: 1.0
page_order: 1.1
nav_title: 2025
layout: dev_guide
noindex: true
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2025/10_14_25.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Use [Deal Cards]({{site.baseurl}}/user_guide/message_building_by_channel/email/h

### Templates for Banners

When you [compose your Banner]({{site.baseurl}}/user_guide/message_building_by_channel/banners/creating_campaigns), you can now start with a blank template, use a Braze template, or select a saved Banner template.
When you [compose your Banner]({{site.baseurl}}/user_guide/message_building_by_channel/banners/create), you can now start with a blank template, use a Braze template, or select a saved Banner template.

## Robust channels

Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2025/11_11_25.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You can [add a background row image]({{site.baseurl}}/user_guide/message_buildin

### Copy preview link

Use **Copy preview link** in your [Banners]({{site.baseurl}}/user_guide/message_building_by_channel/banners/creating_campaigns/#step-6-test-your-message-optional), [email custom footers]({{site.baseurl}}/user_guide/message_building_by_channel/email/custom_email_footer/#creating-your-custom-footer), and [email opt-in and unsubscribe pages]({{site.baseurl}}/user_guide/administrative/app_settings/email_settings/?tab=custom%20footer#subscription-pages-and-footers) to generate a shareable link that shows how your content will look like for a random user.
Use **Copy preview link** in your [Banners]({{site.baseurl}}/user_guide/message_building_by_channel/banners/create/#step-5-test-your-message-optional), [email custom footers]({{site.baseurl}}/user_guide/message_building_by_channel/email/custom_email_footer/#creating-your-custom-footer), and [email opt-in and unsubscribe pages]({{site.baseurl}}/user_guide/administrative/app_settings/email_settings/?tab=custom%20footer#subscription-pages-and-footers) to generate a shareable link that shows how your content will look like for a random user.

### WhatsApp messages with optimized delivery

Expand Down
4 changes: 0 additions & 4 deletions _docs/_releases/2025/12_9_25.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ Because MM API for WhatsApp doesn’t offer 100% deliverability, it's important

To retarget users, we recommend building a segment of users who didn’t receive a specific message. To do this, filter by the error code `131049`, which indicates that a marketing template message was not sent due to WhatsApp’s per-user marketing template limit enforcement. You can do this by [using Braze Currents or SQL Segment Extensions]({{site.baseurl}}/user_guide/message_building_by_channel/whatsapp/whatsapp_campaign/optimized_delivery/#retargeting-users-on-other-braze-channels).

### Dynamic BCC

With [dynamic BCC]({{site.baseurl}}/user_guide/administrative/app_settings/email_settings/?tab=bcc%20address#dynamic-bcc), you can use Liquid in your BCC address. Note that this feature is only available in **Email Preferences** and can’t be set on the campaign itself. Only one BCC address per email recipient is allowed.

## Partnerships

### OtherLevels - Dynamic content
Expand Down
2 changes: 1 addition & 1 deletion _docs/_releases/2025/4_1_25.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ You can [turn off click tracking]({{site.baseurl}}/user_guide/message_building_b
Banners now support Flutter. Additionally, all Banner Card documentation has been overhauled for easier usability. Check out the following articles to get started:

- [About Banners]({{site.baseurl}}/developer_guide/banners/)
- [Creating Banner campaigns]({{site.baseurl}}/user_guide/message_building_by_channel/banners/creating_campaigns/)
- [Creating Banner campaigns]({{site.baseurl}}/user_guide/message_building_by_channel/banners/create/)
- [Embedding Banners into your app]({{site.baseurl}}/developer_guide/banners/placements/)

### WhatsApp click tracking
Expand Down
16 changes: 16 additions & 0 deletions _docs/_releases/2026.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
page_order: 1.0
nav_title: 2026
layout: dev_guide
noindex: true
guide_top_header: "2026 Release Notes"

page_type: landing
description: "This section is home to release notes for 2026."

guide_menu_title: ""
guide_menu_list:
- name: January 8, 2026
link: /docs/releases/2026/1_8_26/
image: /assets/img/braze_icons/snowflake-01.svg
---
Loading