Merge pull request #8758 from braze-inc/develop

Deploy - January 13, 2025
braze-inc · Jan 13, 2025 · 4cc6440 · 4cc6440
2 parents e12e753 + 353032c
commit 4cc6440
Show file tree

Hide file tree

Showing 429 changed files with 7,193 additions and 5,829 deletions.
diff --git a/_config.yml b/_config.yml
@@ -236,7 +236,7 @@ learning_index_name: "BrazeLearningCourses"
 
 # Algolia Search index
 algolia:
-  algolia_api_key: "ef2b60b317325b3227caabd0c9431d4b"
+  algolia_api_key: "ef2b60b317325b3227caabd0c9431d4b" # Read only algolia public search key
   application_id: "1T770XQJ1A"
   index_name: "DocSearch" # You can replace that with whatever name you want
   nodes_to_index: "p,h1,h2,h3,h4,h5,h6,tr,pre,details"

diff --git a/_docs/_api/basics.md b/_docs/_api/basics.md
@@ -54,6 +54,7 @@ For SDK integration, use the [SDK endpoint]({{site.baseurl}}/user_guide/administ
 |US-08| `https://dashboard-08.braze.com` | `https://rest.iad-08.braze.com` | `sdk.iad-08.braze.com` |
 |EU-01| `https://dashboard-01.braze.eu` | `https://rest.fra-01.braze.eu` | `sdk.fra-01.braze.eu` |
 |EU-02| `https://dashboard-02.braze.eu` | `https://rest.fra-02.braze.eu` | `sdk.fra-02.braze.eu` |
+|AU-01| `https://dashboard.au-01.braze.com`| `https://rest.au-01.braze.com` | `sdk.au-01.braze.com` |
 {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4 role="presentation" }
 
 ### API limits

diff --git a/_docs/_api/endpoints/catalogs/catalog_fields/asynchronous/delete_catalog_field.md b/_docs/_api/endpoints/catalogs/catalog_fields/asynchronous/delete_catalog_field.md
@@ -16,9 +16,6 @@ description: "This article outlines details about the Delete catalog field Braze
 {% endapimethod %}
 
 > Use this endpoint to delete a catalog field.
-{% alert important %}
-This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
-{% endalert %}
 
 ## Prerequisites
 

diff --git a/...pi/endpoints/catalogs/catalog_fields/asynchronous/post_create_catalog_fields.md b/...pi/endpoints/catalogs/catalog_fields/asynchronous/post_create_catalog_fields.md
@@ -16,9 +16,6 @@ description: "This article outlines details about the Create catalog fields Braz
 {% endapimethod %}
 
 > Use this endpoint to create multiple fields in your catalog.
-{% alert important %}
-This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
-{% endalert %}
 
 ## Prerequisites
 

diff --git a/.../endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md b/.../endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection.md
@@ -16,9 +16,6 @@ description: "This article outlines details about the Delete catalog selection B
 {% endapimethod %}
 
 > Use this endpoint to delete a catalog selection.
-{% alert important %}
-This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
-{% endalert %}
 
 ## Prerequisites
 

diff --git a/...ints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md b/...ints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections.md
@@ -16,9 +16,6 @@ description: "This article outlines details about the Create catalog selection B
 {% endapimethod %}
 
 > Use this endpoint to create a selection in your catalog.
-{% alert important %}
-This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
-{% endalert %}
 
 ## Prerequisites
 

diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md
@@ -85,10 +85,6 @@ 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 using 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

diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md
@@ -72,10 +72,6 @@ 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 be sent to specifically the user profiles that are both in the API call and qualify for the segment filters.
 {% endalert %}

diff --git a/_docs/_api/endpoints/user_data/post_user_delete.md b/_docs/_api/endpoints/user_data/post_user_delete.md
@@ -16,7 +16,7 @@ description: "This article outlines details about the Delete users Braze endpoin
 
 > Use this endpoint to delete any user profile by specifying a known user identifier.
 
-Up to 50 `external_ids`, `user_aliases`, `braze_ids`, or `email_addresses` can be included in a single request. Only one of `external_ids`, `user_aliases`, `braze_ids`, or `email_addresses` can be included in a single request.
+Up to 50 `external_ids`, `user_aliases`, `braze_ids`, `email_addresses`, or `phone_numbers` can be included in a single request. Only one of `external_ids`, `user_aliases`, `braze_ids`, `email_addresses`, or `phone_numbers` can be included in a single request.
 
 {% alert warning %}
 Deleting user profiles cannot be undone. It will permanently remove users which may cause discrepancies in your data. Learn more about what happens when you [delete a user profile using the API]({{site.baseurl}}/help/help_articles/api/delete_user/) in our Help documentation.
@@ -41,20 +41,22 @@ Authorization: Bearer YOUR_REST_API_KEY
 
 ```json
 {
-  "external_ids" : (optional, array of string) External IDs for the users to delete,
-  "user_aliases" : (optional, array of user alias objects) User aliases for the users to delete,
-  "braze_ids" : (optional, array of string) Braze user identifiers for the users to delete,
-  "email_addresses": (optional, array of string) User emails for the users to delete
+  "external_ids" : (optional, array of string) External IDs to be deleted,
+  "user_aliases" : (optional, array of user alias objects) User aliases to be deleted,
+  "braze_ids" : (optional, array of string) Braze user identifiers to be deleted,
+  "email_addresses": (optional, array of string) User emails to be deleted,
+  "phone_numbers": (optional, array of string) User phone numbers to be deleted
 }
 ```
 ### Request parameters
 
 | Parameter         | Required | Data Type                  | Description                                                                                      |
 |-------------------|----------|----------------------------|--------------------------------------------------------------------------------------------------|
-| `external_ids`    | Optional | Array of strings           | External identifiers for the users to delete.                                                    |
-| `user_aliases`    | Optional | Array of user alias object | [User aliases]({{site.baseurl}}/api/objects_filters/user_alias_object/) for the users to delete. |
-| `braze_ids`       | Optional | Array of strings           | Braze user identifiers for the users to delete.                                                  |
-| `email_addresses` | Optional | Array of strings           | User emails for the users to delete. Refer to [Deleting users by email](#deleting-users-by-email) for more information.                                                             |
+| `external_ids`    | Optional | Array of strings           | External identifiers to be deleted.                                                    |
+| `user_aliases`    | Optional | Array of user alias object | [User aliases]({{site.baseurl}}/api/objects_filters/user_alias_object/) to be deleted. |
+| `braze_ids`       | Optional | Array of strings           | Braze user identifiers to be deleted.                                                  |
+| `email_addresses` | Optional | Array of strings           | User emails to be deleted. Refer to [Deleting users by email](#deleting-users-by-email) for more information.                                                             |
+| `phone_numbers` | Optional | Array of strings | User phone numbers to be deleted. |
 {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4 role="presentation" }
 
 ### Deleting users by email

diff --git a/_docs/_api/endpoints/user_data/post_user_identify.md b/_docs/_api/endpoints/user_data/post_user_identify.md
@@ -15,15 +15,15 @@ description: "This article outlines details about the Identify users Braze endpo
 /users/identify
 {% endapimethod %}
 
-> Use this endpoint to identify an unidentified (alias-only or email-only) user using the provided external ID.
+> Use this endpoint to identify an unidentified (alias-only, email-only, or phone number-only) user using the provided external ID.
 
 {% apiref postman %}https://documenter.getpostman.com/view/4689407/SVYrsdsG?version=latest#5f74e0f7-0620-4c7b-b0a2-f5f38fdbff58 {% endapiref %}
 
 ## How it works
 
-Calling `/users/identify` combines a user profile that is identified by an alias (alias-only profile) or email address (email-only profile) with a user profile that has an `external_id` (identified profile), then removes the alias-only profile. 
+Calling `/users/identify` combines a user profile that is identified by an alias (alias-only profile), email address (email-only profile), or phone number (phone number-only profile) with a user profile that has an `external_id` (identified profile), then removes the alias-only profile. 
 
-Identifying a user requires an `external_id` to be included in the `aliases_to_identify` or `emails_to_identify` object. If there isn't a user with that `external_id`, the `external_id` will be added to the aliased user's record, and the user will be considered identified.
+Identifying a user requires an `external_id` to be included in the `aliases_to_identify` or `emails_to_identify` or `phone_numbers_to_identify` object. If there isn't a user with that `external_id`, the `external_id` will be added to the aliased user's record, and the user will be considered identified.
 
 Note the following:
 
@@ -52,7 +52,8 @@ Authorization: Bearer YOUR_REST_API_KEY
 ```json
 {
    "aliases_to_identify" : (required, array of alias to identify objects),
-   "email_addresses": (optional, array of string) User emails for the users to identify,
+   "emails_to_identify": (optional, array of string) User emails to identify,
+   "phone_numbers_to_identify": (optional, array of string) User phone numbers to identify,
    "merge_behavior": (optional, string) one of 'none' or 'merge' is expected
 }
 ```
@@ -61,11 +62,12 @@ Authorization: Bearer YOUR_REST_API_KEY
 
 You can add up to 50 user aliases per request. You can associate multiple additional user aliases with a single `external_id`.
 
-| Parameter             | Required | Data Type                           | Description                                                                                                                                                                 |
-|-----------------------|----------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `aliases_to_identify` | Required | Array of aliases to identify object | See [alias to identify object]({{site.baseurl}}/api/objects_filters/aliases_to_identify/) and [user alias object]({{site.baseurl}}/api/objects_filters/user_alias_object/). |
-| `emails_to_identify`  | Required | Array of aliases to identify object | See [Identifying users by email](#identifying-users-by-email).                                                                                                              |
-| `merge_behavior`      | Optional | String                              | One of `none` or `merge` is expected. Defaults to `merge`.                                                                                                                                        |
+| Parameter                   | Required | Data Type                           | Description                                                                                                                                                                 |
+|-----------------------------|----------|-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `aliases_to_identify`       | Required | Array of aliases to identify object | See [alias to identify object]({{site.baseurl}}/api/objects_filters/aliases_to_identify/) and [user alias object]({{site.baseurl}}/api/objects_filters/user_alias_object/). |
+| `emails_to_identify`        | Required | Array of aliases to identify object | Email addresses to identify users. See [Identifying users by email](#identifying-users-by-email).                                                                                                              |
+| `phone_numbers_to_identify` | Required | Array of aliases to identify object | Phone numbers to identify users.                                                                                                                                            |
+| `merge_behavior`            | Optional | String                              | One of `none` or `merge` is expected.                                                                                                                                       |
 {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3  .reset-td-br-4 role="presentation" }
 
 #### Merge_behavior field {#merge}

diff --git a/_docs/_api/objects_filters/recipient_object.md b/_docs/_api/objects_filters/recipient_object.md
@@ -13,10 +13,6 @@ description: "This reference article explains the different components of the Br
 
 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/).
 
 ## Object body

diff --git a/_docs/_contributing/styling_examples.md b/_docs/_contributing/styling_examples.md
@@ -151,12 +151,13 @@ Lorem ipsum dolor ``sit amet, consectetur adipiscing elit``. Sed nec tortor at l
 | US-07    | `https://dashboard-07.braze.com`                                      | `https://rest.iad-07.braze.com` |
 | US-08    | `https://dashboard-08.braze.com`                                      | `https://rest.iad-08.braze.com` |
 | EU-01    | `https://dashboard.braze.eu` or<br> `https://dashboard-01.braze.eu`   | `https://rest.fra-01.braze.eu`  |
+| AU-01    | `https://dashboard.au-01.braze.com/`                                  | `https://rest.au-01.braze.com` |
 {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 role="presentation"}
 {% endtab %}
 {% tab Markdown %}
 ```
 | Instance | Dashboard URL                                                         | REST Endpoint                   |
-| -------- | --------------------------------------------------------------------- | ------------------------------- |
+|----------|-----------------------------------------------------------------------|---------------------------------|
 | US-01    | `https://dashboard.braze.com` or<br> `https://dashboard-01.braze.com` | `https://rest.iad-01.braze.com` |
 | US-02    | `https://dashboard-02.braze.com`                                      | `https://rest.iad-02.braze.com` |
 | US-03    | `https://dashboard-03.braze.com`                                      | `https://rest.iad-03.braze.com` |
@@ -167,6 +168,7 @@ Lorem ipsum dolor ``sit amet, consectetur adipiscing elit``. Sed nec tortor at l
 | US-08    | `https://dashboard-08.braze.com`                                      | `https://rest.iad-08.braze.com` |
 | EU-01    | `https://dashboard.braze.eu` or<br> `https://dashboard-01.braze.eu`   | `https://rest.fra-01.braze.eu`  |
 | EU-02    | `https://dashboard-02.braze.eu`                                       | `https://rest.fra-02.braze.eu`  |
+| AU-01    | `https://dashboard.au-01.braze.com/`                                  | `https://rest.au-01.braze.com` |
 {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 role="presentation"}
 ```
 {% endtab %}

diff --git a/_docs/_developer_guide/changelogs.md b/_docs/_developer_guide/changelogs.md
@@ -15,7 +15,7 @@ guide_featured_list:
     link: /docs/developer_guide/platform_integration_guides/swift/changelog/
     image: /assets/img/braze_icons/apple.svg
   - name: iOS SDK (Objective-C)
-    link: /docs/developer_guide/platform_integration_guides/ios/changelog/objc_changelog/
+    link: /docs/developer_guide/platform_integration_guides/legacy_sdks/ios/changelog/objc_changelog/
     image: /assets/img/braze_icons/apple.svg
   - name: Web SDK
     link: /docs/developer_guide/platform_integration_guides/web/changelog/

diff --git a/_docs/_developer_guide/content_cards.md b/_docs/_developer_guide/content_cards.md
@@ -18,7 +18,7 @@ description: "This landing page links to various ways to customize Braze SDK Con
 guide_featured_title: "Section articles"
 guide_featured_list:
   - name: Customizing Content Card Styles
-    link: /docs/developer_guide/customization_guides/content_cards/customizing_styles/
+    link: /docs/developer_guide/content_cards/
     image: /assets/img/braze_icons/brush-02.svg
   - name: Customizing Content Card Behavior
     link: /docs/developer_guide/content_cards/customizing_behavior/
@@ -27,9 +27,9 @@ guide_featured_list:
     link: /docs/developer_guide/content_cards/customizing_feed/
     image: /assets/img/braze_icons/book-closed.svg
   - name: Logging Analytics 
-    link: /docs/developer_guide/customization_guides/content_cards/logging_analytics/
+    link: /docs/developer_guide/content_cards/
     image: /assets/img/braze_icons/navigation-pointer-01.svg
   - name: Creating Custom Content Cards
-    link: /docs/developer_guide/customization_guides/content_cards/creating_custom_content_cards
+    link: /docs/developer_guide/content_cards/
     image: /assets/img/braze_icons/switch-horizontal-01.svg
 ---
diff --git a/_docs/_developer_guide/content_cards/creating_custom_content_cards.md b/_docs/_developer_guide/content_cards/creating_custom_content_cards.md
@@ -14,7 +14,7 @@ platform:
 
 # Creating custom Content Cards
 
-> This article discusses the basic approach you'll use when implementing custom Content Cards, as well as three common use cases: banner images, a message inbox, and a carousel of images. It assumes you've already read the other articles in the Content Card customization guide to understand what can be done by default and what requires custom code. It is especially to understand how to [log analytics]({{site.baseurl}}/developer_guide/customization_guides/content_cards/logging_analytics) for your custom Content Cards. 
+> This article discusses the basic approach you'll use when implementing custom Content Cards, as well as three common use cases: banner images, a message inbox, and a carousel of images. It assumes you've already read the other articles in the Content Card customization guide to understand what can be done by default and what requires custom code. It is especially to understand how to [log analytics]({{site.baseurl}}/developer_guide/content_cards/logging_analytics/) for your custom Content Cards. 
 
 Braze provides different [Content Card types]({{site.baseurl}}/user_guide/message_building_by_channel/content_cards/creative_details): `imageOnly`, `captionedImage`, `classic`, `classicImage`, and `control`. These can be used as a starting place for your implementations, tweaking their look and feel. 
 
@@ -98,7 +98,7 @@ You would handle each of the values. Keys like `body`, `title`, and `buttonText`
 
 {% details Further explanation for Android %}
 
-In the Android and FireOS SDK, the message center logic is driven by the `class_type` value that is provided by the key-value pairs from Braze. Using the [`createContentCardable`]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/implementation_guide) method, you can filter and identify these class types.
+In the Android and FireOS SDK, the message center logic is driven by the `class_type` value that is provided by the key-value pairs from Braze. Using the [`createContentCardable`]({{site.baseurl}}/developer_guide/platform_integration_guides/android/content_cards/examples/) method, you can filter and identify these class types.
 
 {% tabs %}
 {% tab Kotlin %}