Deploy - October 8, 2024

_docs/_api/api_limits.md

@@ -115,6 +115,10 @@ Every single API request sent to Braze returns the following information in the
 
 This information is intentionally included in the header of the response to the API request rather than the Braze dashboard. This allows your system to better react in real time as you're interacting with our API. For example, if the `X-RateLimit-Remaining` value drops below a certain threshold, you might want to slow sending to make sure all transactional emails go out. Or, if it reaches zero, you might want to pause all sending until the time specified in `X-RateLimit-Reset` elapses.
 
+{% alert note %}
+HTTP headers will be returned in all lowercase characters. This behavior aligns with the HTTP/2 protocol that mandates all header field names must be lowercase. This differs from HTTP/1.X where header names were case-insensitive but were commonly written in various capitalizations.
+{% endalert %}
+
 If you have questions about API limits, contact your customer success manager or open a [support ticket][support].
 
 ### Optimal delay between endpoints

_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md

@@ -48,9 +48,11 @@ Authorization: Bearer YOUR-REST-API-KEY
   "recipients": (optional, array; if not provided and broadcast is not set to `false`, message will send to the entire segment targeted by the campaign)
     [
       {
-      // Either "external_user_id" or "user_alias" is required. Requests must specify only one.
+      // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one.
       "user_alias": (optional, user alias object) user alias of user to receive message,
       "external_user_id": (optional, string) external identifier of user to receive message,
+      "email": (optional, string) email address of user to receive message,
+      "prioritization": (optional, array) prioritization array; required when using email,
       "trigger_properties": (optional, object) personalization key-value pairs that will apply to this user (these key-value pairs will override any keys that conflict with the parent trigger_properties),
       "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases; if set to `false`, an attributes object must also be included,
       "attributes": (optional, object) fields in the attributes object will create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values will be overwritten
@@ -83,6 +85,10 @@ Authorization: Bearer YOUR-REST-API-KEY
 - When `send_to_existing_only` is `true`, Braze will only send the message to existing users. However, this flag can't be used with user aliases. 
 - When `send_to_existing_only` is `false`, an attribute must be included. Braze will create a user with the `id` and attributes before sending the message.
 
++{% alert important %}
++Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
++{% endalert %}
+
 A user's subscription group status can be updated via the inclusion of a `subscription_groups` parameter within the `attributes` object. For more details, refer to [User attributes object]({{site.baseurl}}/api/objects_filters/user_attributes_object).
 
 ## Example request
@@ -169,6 +175,8 @@ curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/
 
 Message sending endpoint responses will include the message's `dispatch_id` for reference back to the dispatch of the message. The `dispatch_id` is the ID of the message dispatch, a unique ID for each transmission sent from Braze. When using this endpoint, you receive a single `dispatch_id` for an entire batched set of users. For more information on `dispatch_id` check out our documentation on [Dispatch ID behavior]({{site.baseurl}}/help/help_articles/data/dispatch_id/).
 
+If your request encounters a fatal error, refer to [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors) for the error code and description.
+
 ## Attributes object for campaigns
 
 Braze has a messaging object called `attributes` that will allow you to add, create, or update attributes and values for a user before you send them an API-triggered campaign. Using the `campaign/trigger/send` endpoint as this API call will process the user attributes object before it processes and sends the campaign. This helps minimize the risk of there being issues caused by [race conditions]({{site.baseurl}}/help/best_practices/race_conditions/). 

_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md

@@ -46,9 +46,11 @@ Authorization: Bearer YOUR-REST-API-KEY
   // Including 'audience' will only send to users in the audience
   "recipients": (optional, array; if not provided and broadcast is not set to 'false', message will send to the entire segment targeted by the Canvas)
     [{
-      // Either "external_user_id" or "user_alias" is required. Requests must specify only one.
+      // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one.
       "user_alias": (optional, user alias object) user alias of user to receive message,
       "external_user_id": (optional, string) external identifier of user to receive message,
+      "email": (optional, string) email address of user to receive message,
+      "prioritization": (optional, array) prioritization array; required when using email,
       "canvas_entry_properties": (optional, object) personalization key-value pairs that will apply to this user (these key-value pairs will override any keys that conflict with the parent `canvas_entry_properties`)
       "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases
       "attributes": (optional, object) fields in the attributes object will create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values will be overwritten
@@ -70,6 +72,10 @@ Authorization: Bearer YOUR-REST-API-KEY
 
 Customers using the API for server-to-server calls may need to allowlist the appropriate API URL if they're behind a firewall.
 
++{% alert important %}
++Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
++{% endalert %}
+
 {% alert note %}
 If you include both specific users in your API call and a target segment in the dashboard, the message will send to specifically the user profiles that are both in the API call and qualify for the segment filters.
 {% endalert %}
@@ -164,6 +170,8 @@ The status code `201` could return the following response body. If the Canvas is
 
 If your Canvas is archived, you'll see this `notice` message: "The Canvas is archived. Unarchive the Canvas to ensure trigger requests will take effect." If your Canvas is not active, you'll see this `notice` message: "The Canvas is paused. Resume the Canvas to ensure trigger requests will take effect."
 
+If your request encounters a fatal error, refer to [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors) for the error code and description.
+
 ## Attributes object for Canvas
 
 Use the messaging object `attributes` to add, create, or update attributes and values for a user before sending them an API-triggered Canvas using the `canvas/trigger/send` endpoint. This API call processes the user attributes object before it processes and sends the Canvas. This helps minimize the risk of issues caused by [race conditions]({{site.baseurl}}/help/best_practices/race_conditions/).

_docs/_api/errors.md

@@ -89,7 +89,7 @@ All of the following error codes indicate that no messages will be sent.
 | `400 Android Push Length Exceeded` | JSON payload is more than 4,000 bytes.|
 | `400 Bad Request` | Cannot parse `send_at` datetime.|
 | `400 Bad Request` | In your request, `in_local_time` is true but `time` has passed in your company’s time zone.|
-| `401 Unauthorized` | Invalid API key |
+| `401 Unauthorized` | Invalid API key. |
 | `403 Forbidden` | The rate plan doesn't support, or the account is otherwise inactivated.|
 | `403 Access Denied` | The REST API key you are using does not have sufficient permissions, check the API key permissions under the **Settings** page.|
 | `404 Not Found` | Invalid URL. |

_docs/_api/objects_filters/recipient_object.md

@@ -11,7 +11,11 @@ description: "This reference article explains the different components of the Br
 
 > The recipients object allows you to request or write information in our endpoints.
 
-Either `external_user_id` or `user_alias` is required in this object. **Requests must specify only one.**
+Either `external_user_id`, `user_alias`, or `email` is required in this object. **Requests must specify only one.**
+
+{% alert important %}
+Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
 
 The recipients object allows you to combine the [user alias object]({{site.baseurl}}/api/objects_filters/user_alias_object/), the [trigger properties object]({{site.baseurl}}/api/objects_filters/trigger_properties_object/), and the [Canvas entry properties object]({{site.baseurl}}/api/objects_filters/canvas_entry_properties_object/).
 
@@ -21,13 +25,16 @@ The recipients object allows you to combine the [user alias object]({{site.baseu
 [{
   "user_alias": (optional, User Alias Object) User alias of user to receive message,
   "external_user_id": (optional, string) see External user ID,
+  "email": (optional, string) email address of user to receive message,
+  "prioritization": (optional, array) see Prioritization; required when using email,
   "trigger_properties": (optional, object) personalization key-value pairs for this user when sending a campaign or message; see Trigger Properties,
   "canvas_entry_properties": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas Entry Properties
 }]
 ```
 
 - [User aliases]({{site.baseurl}}/user_guide/data_and_analytics/user_data_collection/user_profile_lifecycle/#user-aliases)
 - [External user ID]({{site.baseurl}}/api/objects_filters/user_attributes_object/#braze-user-profile-fields)
+- [Prioritization]({{site.baseurl}}/api/endpoints/user_data/post_user_identify/#identifying-users-by-email)
 
 ## Recipient object deduping
 

_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios/analytics/disabling_tracking.md

@@ -19,4 +19,4 @@ Additionally, you can use the method [`wipeDataAndDisableForAppRun`](http://appb
 Unless a user uninstalls all apps from a vendor on a given device, the next Braze SDK and app runs after calling `wipeDataAndDisableForAppRun()` will result in our server re-identifying that user via their device identifier (IDFV). In order to fully remove all user data, you should combine a call to `wipeDataAndDisableForAppRun` with a request to delete data on the server via the Braze [REST API]({{site.baseurl}}/developer_guide/rest_api/user_data/#user-delete-endpoint).
 
 ## iOS SDK v5.7.0+
-For devices using iOS SDK v5.7.0 and above, when [disabling IDFV collection](https://www.braze.com/docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/other_sdk_customizations/swift_idfv/), calling [`wipeData`](https://braze-inc.github.io/braze-swift-sdk/documentation/brazekit/braze/wipedata()) will not result in our server re-identifying that user via their device identifier (IDFV).
+For devices using iOS SDK v5.7.0 and above, when [disabling IDFV collection]({{site.baseurl}}/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/other_sdk_customizations/#optional-idfv-collection---swift/), calling [`wipeData`](https://braze-inc.github.io/braze-swift-sdk/documentation/brazekit/braze/wipedata()) will not result in our server re-identifying that user via their device identifier (IDFV).

_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/customization/customizing_feed.md

@@ -15,7 +15,7 @@ noindex: true
 
 You can create your own Content Cards interface by extending `ABKContentCardsTableViewController` to customize all UI elements and Content Cards behavior. The Content Card cells may also be subclassed and then used programmatically or by introducing a custom storyboard that registers the new classes. Check out the Content Cards [sample app](https://github.com/Appboy/appboy-ios-sdk/tree/master/Samples/ContentCards/BrazeContentCardsSampleApp) for a complete example. 
 
-It's also important to consider whether you should use a subclassing strategy versus a completely custom view controller and [subscribe for data updates]({{site.baseurl}}/developer_guide/platform_integration_guides/ios/content_cards/integration/). For example, if you subclass the `ABKContentCardsTableViewController`, you can use the [`populateContentCards` method](#overriding-populated-content-cards) to filter and order cards (recommended). However, if you use a complete view controller customization, you have more control over the card behavior—such as displaying in a carousel or adding interactive elements—but you then have to rely on an observer to implement ordering and filtering logic. You must also implement the respective analytics methods to properly log impressions, dismissal events, and clicks.
+It's also important to consider whether you should use a subclassing strategy versus a completely custom view controller and [subscribe for data updates]({{site.baseurl}}/developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/integration/). For example, if you subclass the `ABKContentCardsTableViewController`, you can use the [`populateContentCards` method](#overriding-populated-content-cards) to filter and order cards (recommended). However, if you use a complete view controller customization, you have more control over the card behavior—such as displaying in a carousel or adding interactive elements—but you then have to rely on an observer to implement ordering and filtering logic. You must also implement the respective analytics methods to properly log impressions, dismissal events, and clicks.
 
 ## Customizing UI
 

_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/customization/use_cases/carousel_view.md

@@ -29,13 +29,13 @@ In terms of the level of development effort, the key differences between the bas
 
 ### Step 1: Create a custom view controller
 
-To create the Content Cards carousel, create your own custom view controller (such as `UICollectionViewController`) and [subscribe for data updates]({{site.baseurl}}/developer_guide/platform_integration_guides/ios/content_cards/integration/#getting-the-data). Note that you won't be able to extend or subclass our default `ABKContentCardTableViewController`, as it's only able to handle our default Content Card types.
+To create the Content Cards carousel, create your own custom view controller (such as `UICollectionViewController`) and [subscribe for data updates]({{site.baseurl}}/developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/integration/#getting-the-data). Note that you won't be able to extend or subclass our default `ABKContentCardTableViewController`, as it's only able to handle our default Content Card types.
 
 ### Step 2: Implement analytics
 
 When creating a fully custom view controller, Content Card impressions, clicks, and dismissals are not automatically logged. You must implement the respective analytics methods to ensure impressions, dismissal events, and clicks get properly logged back to the Braze dashboard analytics.
 
-For information on the analytics methods, refer to [Card methods]({{site.baseurl}}/developer_guide/platform_integration_guides/ios/content_cards/integration/#card-methods). 
+For information on the analytics methods, refer to [Card methods]({{site.baseurl}}/developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/integration/#card-methods). 
 
 {% alert note %}
 The same page also details the different properties inherited from our generic Content Card model class, which you may find useful during your view implementation.

_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/implementation_guide.md

@@ -14,7 +14,7 @@ noindex: true
 
 <br>
 {% alert important %}
-Looking for the basic Content Card developer integration guide? Find it [here]({{site.baseurl}}/developer_guide/platform_integration_guides/ios/content_cards/integration/).
+Looking for the basic Content Card developer integration guide? Find it [here]({{site.baseurl}}/developer_guide/platform_integration_guides/legacy_sdks/ios/content_cards/integration/).
 {% endalert %}
 
 # Content Card implementation guide

_docs/_developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/overview.md

@@ -12,22 +12,22 @@ description: "This landing page covers Braze SDK integration guides for CocoaPod
 guide_featured_title: "Basic integration options"
 guide_featured_list:
 - name: CocoaPods
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/installation_methods/cocoapods/
+  link: /developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/installation_methods/cocoapods/
   image: /assets/img/cocoapods.png
 - name: Swift Package Manager (SPM)
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/installation_methods/swift_package_manager/
+  link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/installation_methods/swift_package_manager/
   image: /assets/img/braze_icons/swift.svg
 - name: Carthage
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/installation_methods/carthage_integration/
+  link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/installation_methods/carthage_integration/
   image: /assets/img/carthage.png
 - name: Manual
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/installation_methods/manual_integration_options/
+  link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/installation_methods/manual_integration_options/
   image: /assets/img/braze_icons/tool-01.svg
 - name: "Completing the Integration"
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/completing_integration/
+  link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/completing_integration/
   image: /assets/img/braze_icons/flag-05.svg
 - name: "Other Optional SDK Customizations"
-  link: /docs/developer_guide/platform_integration_guides/ios/initial_sdk_setup/other_sdk_customizations/
+  link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/initial_sdk_setup/ios_sdk_integration
   image: /assets/img/braze_icons/user-square.svg
 
 noindex: true

_docs/_developer_guide/platform_integration_guides/swift/live_activities/faq.md

@@ -76,7 +76,7 @@ The limits are defined by Apple and can vary based on a number of factors. They
 
 ### What other things should I watch out for during troubleshooting?
 
-- Check that you are using a `.p8` key for authentication.
+- Ensure that you are using a `.p8` key for authentication instead of a `.p12` or `.pem` file.
 - Check that your push provisioning profile matches the environment you’re testing. Universal certificates may be configured in the Braze dashboard to send to either the development or production Apple Push Notification service (APNs) environment. Using a development certificate for a production app or a production certificate for a development app will not work.
 
 

_docs/_developer_guide/platform_integration_guides/swift/live_activities/live_activities.md

@@ -25,6 +25,7 @@ Additional prerequisites include:
 
 - Live Activities are only available for iPhones and iPads on iOS 16.1 and later. To use this feature, ensure that your project is targeting this iOS version.
 - The `Push Notification` entitlement must be added under **Signing & Capabilities** in your Xcode project.
+- Live Activities require using a `.p8` key to send the notification. Older files such as a `.p12` or `.pem` are not supported.
 - Starting with version 8.2.0 of the Braze Swift SDK, you can [remotely register a Live Activity](#step-2-start-the-activity). To use this feature, iOS 17.2 or later is required.
 
 {% alert note %}

_docs/_developer_guide/platform_integration_guides/unity/push_notifications/android.md

@@ -113,3 +113,6 @@ Although Braze can handle standard deep links (such as website URLs, Android URI
 
 For setup guidance, visit [Deep Linking to In-App Resources](https://developer.android.com/training/app-links/deep-linking).
 
+## Adding Braze push notification icons
+
+To add push icons to your project, create an Android Archive (AAR) plug-in or Android library that contains the icon image files. For steps and information, refer to Unity's documentation: [Android Library Projects and Android Archive plug-ins](https://docs.unity3d.com/Manual/AndroidAARPlugins.html).