Merge pull request #7826 from braze-inc/develop

Deploy - August 6, 2024
braze-inc · Aug 6, 2024 · 9df8c93 · 9df8c93
2 parents 09468db + 462b2f2
commit 9df8c93
Show file tree

Hide file tree

Showing 39 changed files with 490 additions and 148 deletions.
diff --git a/_docs/_api/endpoints/export/canvas/get_canvas_details.md b/_docs/_api/endpoints/export/canvas/get_canvas_details.md
@@ -42,7 +42,7 @@ curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/details?c
 ```
 {% endraw %}
 
-## Response
+## Responses
 
 {% alert note %}
 All Canvas steps have a `next_paths` field, which is an array of `{name, next_step_id}` data. For full steps and Message steps, the `next_step_ids` field will be present, but will not contain data for other Canvas Flow steps.
@@ -101,6 +101,125 @@ Authorization: Bearer YOUR-REST-API-KEY
 }
 ```
 
+### Messages by channel
+
+The following is an example response that includes Canvas messages sent through different channels (email, push, SMS, and in-app messages):
+
+```json
+{
+  "message": "success",
+  "created_at": "2023-01-01T12:00:00Z",
+  "updated_at": "2023-01-10T12:00:00Z",
+  "name": "Multi-Channel Engagement",
+  "description": "Complete profile reminder via multiple channels",
+  "archived": false,
+  "draft": false,
+  "schedule_type": "date",
+  "first_entry": "2023-01-01T12:00:00Z",
+  "last_entry": "2023-01-10T12:00:00Z",
+  "channels": ["email", "push", "sms", "in_app_message"],
+  "variants": [
+    {
+      "name": "Variant 1",
+      "id": "variant_1_id",
+      "first_step_ids": ["step_1"]
+    }
+  ],
+  "tags": ["engagement", "multi-channel"],
+  "teams": ["Marketing Team"],
+  "steps": [
+    {
+      "name": "Welcome Email",
+      "type": "email",
+      "id": "step_1",
+      "next_step_ids": ["step_2"],
+      "next_paths": [
+        {
+          "name": "Next Step",
+          "next_step_id": "step_2"
+        }
+      ],
+      "channels": ["email"],
+      "messages": {
+        "message_1": {
+          "channel": "email",
+          "subject": "Welcome to Kitchenerie!",
+          "body": "<html><body>Welcome to the Kitchenerie family, {{first_name}}!</body></html>",
+          "created_at": "2023-01-01T12:00:00Z",
+          "updated_at": "2023-01-01T12:00:00Z"
+        }
+      }
+    },
+    {
+      "name": "Follow-Up Push Notification",
+      "type": "push",
+      "id": "step_2",
+      "next_step_ids": ["step_3"],
+      "next_paths": [
+        {
+          "name": "Next Step",
+          "next_step_id": "step_3"
+        }
+      ],
+      "channels": ["push"],
+      "messages": {
+        "message_2": {
+          "channel": "push",
+          "title": "Don't Forget to Complete Your Kitchenerie Profile",
+          "body": "Complete your Kitchenerie profile for access to special offers and local events.",
+          "created_at": "2023-01-02T12:00:00Z",
+          "updated_at": "2023-01-02T12:00:00Z"
+        }
+      }
+    },
+    {
+      "name": "Reminder SMS",
+      "type": "sms",
+      "id": "step_3",
+      "next_step_ids": ["step_4"],
+      "next_paths": [
+        {
+          "name": "Next Step",
+          "next_step_id": "step_4"
+        }
+      ],
+      "channels": ["sms"],
+      "messages": {
+        "message_3": {
+          "channel": "sms",
+          "body": "Hi {{first_name}}, remember to complete Kitchenerie your profile!",
+          "created_at": "2023-01-03T12:00:00Z",
+          "updated_at": "2023-01-03T12:00:00Z"
+        }
+      }
+    },
+    {
+      "name": "In-App Message",
+      "type": "in_app_message",
+      "id": "step_4",
+      "next_step_ids": [],
+      "next_paths": [],
+      "channels": ["in_app_message"],
+      "messages": {
+        "message_4": {
+          "channel": "in_app_message",
+          "header": "Complete Your Kitchenerie Profile",
+          "body": "Complete your Kitchenerie profile to unlock access to savings and local events!",
+          "created_at": "2023-01-04T12:00:00Z",
+          "updated_at": "2023-01-04T12:00:00Z"
+        }
+      }
+    }
+  ],
+  "entry_criteria": {
+    "segment_id": "new_users_segment"
+  },
+  "exit_criteria": {
+    "event_name": "completed_profile"
+  }
+}
+```
+
 {% alert tip %}
 For help with CSV and API exports, visit [Export troubleshooting]({{site.baseurl}}/user_guide/data_and_analytics/export_braze_data/export_troubleshooting/).
 {% endalert %}

diff --git a/_docs/_api/endpoints/scim/delete_existing_dashboard_user.md b/_docs/_api/endpoints/scim/delete_existing_dashboard_user.md
@@ -17,7 +17,7 @@ description: "This article outlines details about the Remove a dashboard user ac
 
 > Use this endpoint to permanently delete an existing dashboard user by specifying the resource `id` returned by the SCIM [`POST`]({{site.baseurl}}/scim/post_create_user_account/) method. 
 
-This is similar to deleting a user in the **Manage Users** section of the Braze dashboard. For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/).
+This is similar to deleting a user in the **Company Users** section of the Braze dashboard. For information on how to obtain a SCIM token, visit [Automated user provisioning]({{site.baseurl}}/scim/automated_user_provisioning/).
 
 {% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#9c7c71ea-afd6-414a-99d1-4eb1fe274f16 {% endapiref %}
 

diff --git a/_docs/_contributing/yaml_front_matter/page_layouts.md b/_docs/_contributing/yaml_front_matter/page_layouts.md
@@ -78,7 +78,7 @@ guide_top_text: ><br>
 
 ### Blank config
 
-The `blank_config` value is used to hide a page on Braze Docs and automatically redirect users to `www.braze.com/docs`. For more information, see [Redirecting URLs]({{site.baseurl}}/contributing/content_management/redirecting_urls/?tab=home%20page#redirecting-a-page).
+The `blank_config` value is combined with `config_only: true` to make the current article a folder. This lets you create subsections without needing a landing page. Because the landing page becomes a folder and has no page content, users who try to visit the URL directly are automatically redirected to `www.braze.com/docs`. For more information, see [Redirecting URLs]({{site.baseurl}}/contributing/content_management/redirecting_urls/?tab=home%20page#redirecting-a-page).
 
 ### Redirect
 

diff --git a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios.md b/_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios.md
@@ -3,6 +3,6 @@ nav_title: iOS (legacy)
 config_only: true
 noindex: true
 layout: redirect
-redirect_to: /docs/developer_guide/platform_integration_guides/swift/initial_sdk_setup/overview/
+redirect_to: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/overview
 page_order: 12
 ---
diff --git a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/macOS.md b/_docs/_developer_guide/platform_integration_guides/legacy_sdks/macOS.md
@@ -3,6 +3,6 @@ nav_title: MacOS (legacy)
 config_only: true
 noindex: true
 layout: redirect
-redirect_to: /docs/developer_guide/platform_integration_guides/macOS/initial_sdk_setup/
+redirect_to: /docs/developer_guide/platform_integration_guides/legacy_sdks/macOS/initial_sdk_setup
 page_order: 13
 ---
diff --git a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos.md b/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos.md
@@ -3,6 +3,6 @@ nav_title: tvOS (legacy)
 config_only: true
 noindex: true
 layout: redirect
-redirect_to: /docs/developer_guide/platform_integration_guides/tvos/initial_sdk_setup/
+redirect_to: /docs/developer_guide/platform_integration_guides/legacy_sdks/tvos/initial_sdk_setup
 page_order: 14
 ---
diff --git a/_docs/_developer_guide/platform_integration_guides/xamarin/initial_sdk_setup.md b/_docs/_developer_guide/platform_integration_guides/xamarin/initial_sdk_setup.md
@@ -47,7 +47,7 @@ A Xamarin binding is a way to use native libraries in Xamarin apps.  The impleme
 
 {% subtabs local %}
 {% subtab NuGet %}
-The simplest integration method involves getting the Braze SDK from the [NuGet.org][2] central repository. In the Visual Studio sidebar, right-click `Packages` folder and click `Add Packages...`.  Search for 'Braze' and install the latest Xamarin iOS NuGet packages: [Braze.iOS.BrazeKit](https://www.nuget.org/packages/Braze.iOS.BrazeKit), [Braze.iOS.BrazeUI](https://www.nuget.org/packages/Braze.iOS.BrazeUI), and [Braze.iOS.BrazeLocation]https://www.nuget.org/packages/Braze.iOS.BrazeLocation into your project.
+The simplest integration method involves getting the Braze SDK from the [NuGet.org](https://www.nuget.org/) central repository. In the Visual Studio sidebar, right-click `Packages` folder and click `Add Packages...`.  Search for 'Braze' and install the latest Xamarin iOS NuGet packages: [Braze.iOS.BrazeKit](https://www.nuget.org/packages/Braze.iOS.BrazeKit), [Braze.iOS.BrazeUI](https://www.nuget.org/packages/Braze.iOS.BrazeUI), and [Braze.iOS.BrazeLocation]https://www.nuget.org/packages/Braze.iOS.BrazeLocation into your project.
 
 We also provide the compatibility libraries packages: [Braze.iOS.BrazeKitCompat](https://www.nuget.org/packages/Braze.iOS.BrazeKitCompat) and [Braze.iOS.BrazeUICompat](https://www.nuget.org/packages/Braze.iOS.BrazeUICompat), to help make your migration to .NET MAUI easier.
 {% endsubtab %}

diff --git a/_docs/_help/help_articles/email/open_rates.md b/_docs/_help/help_articles/email/open_rates.md
@@ -19,6 +19,6 @@ Ultimately, after an email has left our servers, we have limited visibility into
 1. Be aware that this can happen to any sender and nearly any recipient. Clicks, like opens, are not entirely reliable indicators of human interaction with your messages, meaning NHI is not preventable.
 2. Because higher positive engagement tends to correlate with lower NHI, it's important to follow email messaging [best practices]({{site.baseurl}}/user_guide/message_building_by_channel/email/best_practices). This includes getting explicit permission from your users to send email and sunsetting unengaged subscribers on a regular cadence. 
 3. Use HTTPS links in your emails when possible. NHI is less common for senders using secure links.
-4. If you currently use a single-click unsubscribe process, consider creating a [custom unsubscribe page]({{site.baseurl}}//user_guide/message_building_by_channel/email/managing_user_subscriptions/#creating-a-custom-unsubscribe-page) that takes users to a default landing page to confirm their request to unsubscribe. This can be helpful because NHI can inadvertently unsubscribe users.
+4. If you currently use a single-click unsubscribe process, consider creating a [preference center]({{site.baseurl}}/user_guide/message_building_by_channel/email/preference_center/overview) that takes users to a page to edit and manage their notification preferences. This can be helpful because NHI can inadvertently unsubscribe users.
 5. Consider using [other metrics]({{site.baseurl}}/user_guide/message_building_by_channel/email/reporting_and_analytics/email_reporting/#email-performance) to measure your email marketing success, such as conversions, app sessions, or site visits.
 6. Add a hidden link in your email campaigns. This link would be something that a human wouldn't notice like white-on-white text or a punctuation mark. Since bots tend to click all links, you can conclude that users generating click events on the invisible link are actually the result of NHI, so the open or click doesn't necessarily indicate positive engagement.
diff --git a/_docs/_help/help_articles/push/push_unsubscribes.md b/_docs/_help/help_articles/push/push_unsubscribes.md
@@ -10,7 +10,7 @@ channel: push
 
 Push unsubscribes depend on updates to a user’s push status from providers like Apple or Google. These updates can be infrequent and unpredictable. As a result, push unsubscribes are not included as a metric in push campaign analytics. 
 
-However, manually tracking push unsubscribes can still provide valuable insights into user responses to your notification frequency and content relevance. Here's are two options for tracking push unsubscribes.
+However, manually tracking push unsubscribes can still provide valuable insights into user responses to your notification frequency and content relevance. Here are two options for tracking push unsubscribes.
 
 ## Option 1: Use segment filters
 
@@ -25,6 +25,10 @@ Note the segmentation filters will be approximate and cannot be specifically tie
 
 ## Option 2: Use a custom event
 
+{% alert important %}
+Be aware that logging a custom event for subscription change will consume [data points]({{site.baseurl}}/user_guide/data_and_analytics/data_points#consumption-count). Alternatively, use segment filters to identify and target users who aren't push enabled.
+{% endalert %}
+
 For a different workaround, we also recommend creating a custom event for push unsubscribes based on whether a user's push enabled status is `true` or `false` in order to track this metric.
 
-_Last updated on June 13, 2024_
+_Last updated on June 13, 2024_
diff --git a/_docs/_hidden/other/documentation_request.md b/_docs/_hidden/other/documentation_request.md
@@ -437,9 +437,9 @@ hide_toc: true
                 Request Type
                 </label>
               <select id="doc_urgent" name="Request_Type" class="drop-down-sel">
-              <option value="urgent">Urgent — This request raises smoke on the Doc Site or requires a high-priority change.</option>
-              <option value="feature_release">Feature Release: Feature Update - This request is for new or existing product features that need to be communicated to the Tech Writing and Braze Learning teams.</option>
-              <option value="standard" selected="selected">Standard: I have a suggestion, question about, or update to an article.</option>
+              <option value="urgent">Urgent: Raise smoke on the Doc Site or request a high-priority change</option>
+              <option value="feature_release">Feature update: Communicate new or updated product features with Tech Writing and Braze Learning</option>
+              <option value="standard" selected="selected">Standard: I have a suggestion, question about, or update to an article</option>
               </select>
 
               </div>

diff --git a/_docs/_partners/data_and_infrastructure_agility.md b/_docs/_partners/data_and_infrastructure_agility.md
@@ -133,4 +133,6 @@ valid_partner_list:
   url: /docs/partners/data_and_infrastructure_agility/workflow_automation/metarouter/
 - name: Treasure Data
   url: /docs/partners/data_and_infrastructure_agility/cohort_import/treasuredata/
+- name: LiveRamp
+  url: /docs/partners/data_and_infrastructure_agility/advertising/liveramp/
 ---
diff --git a/_docs/_partners/data_and_infrastructure_agility/advertising.md b/_docs/_partners/data_and_infrastructure_agility/advertising.md
@@ -0,0 +1,20 @@
+---
+nav_title: Advertising
+article_title: Advertising
+page_order: 1
+config_only: true
+
+page_type: landing
+description: "This landing page lists Braze partners (Alloys) who offer various advertising technologies."
+
+layout: partner_page
+search_tag: Partner
+partner_api: "https://www.braze.com/api/v1/partners"
+partner_path: "https://www.braze.com/product/alloys/partners/"
+
+partner_top_header: "Advertising"
+
+valid_partner_list:
+- name: LiveRamp
+  url: /docs/partners/data_and_infrastructure_agility/advertising/liveramp/
+---