Merge pull request #83 from braze-inc/docs-sync/public-docs-mirror

Mirror public docs markdown from braze.com/docs (2026-08-25)

Author: lydia-xie

changes/2026-08-25.md

@@ -0,0 +1,163 @@
+# Daily docs markdown sync - 2026-08-25
+
+## Summary
+- Source: https://www.braze.com/docs/sitemap.xml
+- Changed files: 156
+
+## Changes
+- M `docs/API/basics/index.md`
+- M `docs/API/endpoints/apps/post_update_push_credential/index.md`
+- M `docs/API/endpoints/catalogs/catalog_fields/asynchronous/delete_catalog_field/index.md`
+- M `docs/API/endpoints/catalogs/catalog_fields/asynchronous/post_create_catalog_fields/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/delete_catalog_items_bulk/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item/index.md`
+- M `docs/API/endpoints/catalogs/catalog_items/synchronous/put_update_catalog_item/index.md`
+- M `docs/API/endpoints/catalogs/catalog_management/synchronous/delete_catalog/index.md`
+- M `docs/API/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/index.md`
+- M `docs/API/endpoints/catalogs/catalog_management/synchronous/post_create_catalog/index.md`
+- M `docs/API/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection/index.md`
+- M `docs/API/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections/index.md`
+- M `docs/API/endpoints/cdi/get_integration_list/index.md`
+- M `docs/API/endpoints/cdi/get_job_sync_status/index.md`
+- M `docs/API/endpoints/cdi/post_job_sync/index.md`
+- M `docs/API/endpoints/email/get_list_hard_bounces/index.md`
+- M `docs/API/endpoints/email/get_query_unsubscribed_email_addresses/index.md`
+- M `docs/API/endpoints/email/post_blacklist/index.md`
+- M `docs/API/endpoints/email/post_blocklist/index.md`
+- M `docs/API/endpoints/email/post_email_subscription_status/index.md`
+- M `docs/API/endpoints/email/post_remove_hard_bounces/index.md`
+- M `docs/API/endpoints/email/post_remove_spam/index.md`
+- M `docs/API/endpoints/export/campaigns/get_campaign_analytics/index.md`
+- M `docs/API/endpoints/export/campaigns/get_campaign_details/index.md`
+- M `docs/API/endpoints/export/campaigns/get_campaigns/index.md`
+- M `docs/API/endpoints/export/campaigns/get_send_analytics/index.md`
+- M `docs/API/endpoints/export/canvas/get_canvas_analytics/index.md`
+- M `docs/API/endpoints/export/canvas/get_canvas_analytics_summary/index.md`
+- M `docs/API/endpoints/export/canvas/get_canvas_details/index.md`
+- M `docs/API/endpoints/export/canvas/get_canvases/index.md`
+- M `docs/API/endpoints/export/custom_attributes/get_custom_attributes/index.md`
+- M `docs/API/endpoints/export/custom_events/get_custom_events/index.md`
+- M `docs/API/endpoints/export/custom_events/get_custom_events_analytics/index.md`
+- M `docs/API/endpoints/export/custom_events/get_custom_events_data/index.md`
+- M `docs/API/endpoints/export/kpi/get_kpi_daily_new_users_date/index.md`
+- M `docs/API/endpoints/export/kpi/get_kpi_dau_date/index.md`
+- M `docs/API/endpoints/export/kpi/get_kpi_mau_30_days/index.md`
+- M `docs/API/endpoints/export/kpi/get_kpi_uninstalls_date/index.md`
+- M `docs/API/endpoints/export/purchases/get_list_product_id/index.md`
+- M `docs/API/endpoints/export/purchases/get_number_of_purchases/index.md`
+- M `docs/API/endpoints/export/purchases/get_revenue_series/index.md`
+- M `docs/API/endpoints/export/segments/get_segment/index.md`
+- M `docs/API/endpoints/export/segments/get_segment_analytics/index.md`
+- M `docs/API/endpoints/export/segments/get_segment_details/index.md`
+- M `docs/API/endpoints/export/segments/post_cancel_export/index.md`
+- M `docs/API/endpoints/export/sessions/get_sessions_analytics/index.md`
+- M `docs/API/endpoints/export/user_data/post_users_global_control_group/index.md`
+- M `docs/API/endpoints/export/user_data/post_users_identifier/index.md`
+- M `docs/API/endpoints/export/user_data/post_users_segment/index.md`
+- M `docs/API/endpoints/media_library/manage_assets/create/index.md`
+- M `docs/API/endpoints/media_library/manage_assets/replace_file/index.md`
+- M `docs/API/endpoints/messaging/duplicate_messages/post_duplicate_campaigns/index.md`
+- M `docs/API/endpoints/messaging/duplicate_messages/post_duplicate_canvases/index.md`
+- M `docs/API/endpoints/messaging/live_activity/start/index.md`
+- M `docs/API/endpoints/messaging/live_activity/update/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/get_messages_scheduled/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_messages/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_canvases/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_messages/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_messages/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_messages/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_campaigns/index.md`
+- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_canvases/index.md`
+- M `docs/API/endpoints/messaging/send_messages/post_create_send_ids/index.md`
+- M `docs/API/endpoints/messaging/send_messages/post_send_messages/index.md`
+- M `docs/API/endpoints/messaging/send_messages/post_send_transactional_message/index.md`
+- M `docs/API/endpoints/messaging/send_messages/post_send_triggered_campaigns/index.md`
+- M `docs/API/endpoints/messaging/send_messages/post_send_triggered_canvases/index.md`
+- M `docs/API/endpoints/preference_center/get_create_url_preference_center/index.md`
+- M `docs/API/endpoints/preference_center/get_list_preference_center/index.md`
+- M `docs/API/endpoints/preference_center/get_view_details_preference_center/index.md`
+- M `docs/API/endpoints/preference_center/post_create_preference_center/index.md`
+- M `docs/API/endpoints/preference_center/put_update_preference_center/index.md`
+- M `docs/API/endpoints/scim/delete_existing_dashboard_user/index.md`
+- M `docs/API/endpoints/scim/get_search_existing_dashboard_user/index.md`
+- M `docs/API/endpoints/scim/get_see_user_account_information/index.md`
+- M `docs/API/endpoints/scim/post_create_user_account/index.md`
+- M `docs/API/endpoints/scim/put_update_existing_user_account/index.md`
+- M `docs/API/endpoints/sdk_authentication/delete_sdk_authentication_key/index.md`
+- M `docs/API/endpoints/sdk_authentication/get_sdk_authentication_keys/index.md`
+- M `docs/API/endpoints/sdk_authentication/post_create_sdk_authentication_key/index.md`
+- M `docs/API/endpoints/sdk_authentication/put_primary_sdk_authentication_key/index.md`
+- M `docs/API/endpoints/sms/get_query_invalid_numbers/index.md`
+- M `docs/API/endpoints/sms/post_remove_invalid_numbers/index.md`
+- M `docs/API/endpoints/subscription_groups/get_list_user_subscription_group_status/index.md`
+- M `docs/API/endpoints/subscription_groups/get_list_user_subscription_groups/index.md`
+- M `docs/API/endpoints/subscription_groups/post_update_user_subscription_group_status/index.md`
+- M `docs/API/endpoints/subscription_groups/post_update_user_subscription_group_status_v2/index.md`
+- M `docs/API/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/index.md`
+- M `docs/API/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/index.md`
+- M `docs/API/endpoints/templates/content_blocks_templates/post_create_email_content_block/index.md`
+- M `docs/API/endpoints/templates/content_blocks_templates/post_update_content_block/index.md`
+- M `docs/API/endpoints/templates/email_templates/get_list_email_templates/index.md`
+- M `docs/API/endpoints/templates/email_templates/get_see_email_template_information/index.md`
+- M `docs/API/endpoints/templates/email_templates/post_create_email_template/index.md`
+- M `docs/API/endpoints/templates/email_templates/post_update_email_template/index.md`
+- M `docs/API/endpoints/translations/campaigns/get_source_campaign/index.md`
+- M `docs/API/endpoints/translations/campaigns/get_translation_campaign/index.md`
+- M `docs/API/endpoints/translations/campaigns/put_update_translation_campaign/index.md`
+- M `docs/API/endpoints/translations/canvas/get_source_canvas/index.md`
+- M `docs/API/endpoints/translations/canvas/get_translation_canvas/index.md`
+- M `docs/API/endpoints/translations/canvas/put_update_translation_canvas/index.md`
+- M `docs/API/endpoints/translations/content_blocks/get_source_content_block/index.md`
+- M `docs/API/endpoints/translations/content_blocks/get_translation_content_block/index.md`
+- M `docs/API/endpoints/translations/content_blocks/put_update_translation_content_block/index.md`
+- M `docs/API/endpoints/translations/email_templates/get_view_source_template/index.md`
+- M `docs/API/endpoints/translations/email_templates/get_view_translation_locale_template/index.md`
+- M `docs/API/endpoints/translations/email_templates/get_view_translation_template/index.md`
+- M `docs/API/endpoints/translations/email_templates/put_update_template/index.md`
+- M `docs/API/endpoints/user_data/external_id_migration/post_external_ids_remove/index.md`
+- M `docs/API/endpoints/user_data/external_id_migration/post_external_ids_rename/index.md`
+- M `docs/API/endpoints/user_data/post_user_alias/index.md`
+- M `docs/API/endpoints/user_data/post_user_delete/index.md`
+- M `docs/API/endpoints/user_data/post_user_identify/index.md`
+- M `docs/API/endpoints/user_data/post_user_track/index.md`
+- M `docs/API/endpoints/user_data/post_user_track_bulk/index.md`
+- M `docs/API/endpoints/user_data/post_user_track_synchronous/index.md`
+- M `docs/API/endpoints/user_data/post_users_alias_update/index.md`
+- M `docs/API/endpoints/user_data/post_users_merge/index.md`
+- M `docs/API/objects_filters/messaging/email_object/index.md`
+- M `docs/Developer Guide/changelogs/index.md`
+- M `docs/Developer Guide/getting_started/platform_overview/index.md`
+- M `docs/Developer Guide/push_notifications/deep_linking_troubleshooting/index.md`
+- M `docs/Developer Guide/push_notifications/ios_deep_linking_guide/index.md`
+- M `docs/Developer Guide/sdk_integration/reading_verbose_logs/index.md`
+- M `docs/Technology Partners/data_and_analytics/customer_data_platform/segment/segment/index.md`
+- M `docs/Technology Partners/ecommerce/shopify/shopify_segments_sync/index.md`
+- M `docs/User Guide/analytics/metrics_glossary/index.md`
+- M `docs/User Guide/audience/segments/segment_extension/sql_segments/use_cases/index.md`
+- M `docs/User Guide/brazeai/agents/examples/index.md`
+- M `docs/User Guide/channels/email/best_practices/email_guidelines/index.md`
+- M `docs/User Guide/channels/email/customize/universal_links_and_app_links/index.md`
+- M `docs/User Guide/channels/email/reporting/analytics_glossary/index.md`
+- M `docs/User Guide/channels/in_app_messages/best_practices/prep_guide/index.md`
+- M `docs/User Guide/channels/in_app_messages/drag_and_drop/surveys/index.md`
+- M `docs/User Guide/channels/in_app_messages/faq/index.md`
+- M `docs/User Guide/channels/whatsapp/message_processing/opt_ins_and_opt_outs/index.md`
+- M `docs/User Guide/data/distribution/braze_currents/event_glossary/currents_changelogs/index.md`
+- M `docs/User Guide/data/distribution/braze_currents/event_glossary/customer_behavior_events/index.md`
+- M `docs/User Guide/data/distribution/braze_currents/event_glossary/message_engagement_events/index.md`
+- M `docs/User Guide/data/distribution/braze_currents/event_glossary/user_profiles_events/index.md`
+- M `docs/User Guide/data/unification/cloud_ingestion/index.md`
+- M `docs/User Guide/messaging/campaigns/schedule_your_campaign/triggered_delivery/index.md`
+- M `docs/User Guide/messaging/canvas/create_a_canvas/context_and_event_properties/canvas_persistent_entry_properties/index.md`
+- M `docs/User Guide/messaging/design_and_edit/personalize/liquid/liquid_use_cases/index.md`
+- M `docs/User Guide/messaging/landing_pages/create_landing_pages/surveys/index.md`
+- A `docs/User Guide/messaging/surveys/index.md`

docs/API/basics/index.md

@@ -414,6 +414,12 @@ On each request, Braze performs the following server-side validation checks:
 
 If authentication fails, the API returns an error response with an HTTP status code. For example, `401 Unauthorized` indicates an invalid or missing key, while `403 Forbidden` indicates the key doesn't have permission for the requested endpoint. For more information, see [API errors](https://www.braze.com/docs/api/errors).
 
+### Request header casing {#header-casing}
+
+HTTP header names are case-insensitive, so `Authorization` and `authorization` are equivalent. The same applies to other standard request headers, such as `Content-Type`. Send whichever casing your HTTP client produces.
+
+Braze also accepts any casing of the `Bearer` scheme (`Bearer`, `bearer`, or `BEARER`). Send the REST API key itself exactly as it was issued.
+
 ### Network-level security
 
 REST API requests to Braze are protected by Transport Layer Security (TLS) encryption across the full request path. The following table describes the network flow for an API request from your server to Braze:

docs/API/endpoints/apps/post_update_push_credential/index.md

@@ -1,4 +1,4 @@
-<div id='api_wicdjouehcwd' class='api_div' data-search-keywords='prerequisites app_id apple certificate jwt_key_id jwt_team_id jwt_bundle_id apns_gateway firebase credential huawei app_secret kindle client_id client_secret message'>
+<div id='api_liqimcjgcqlf' class='api_div' data-search-keywords='update push credentials app_id apple certificate jwt_key_id jwt_team_id jwt_bundle_id apns_gateway firebase credential huawei app_secret kindle client_id client_secret message'>
 <h1 id="update-push-credentials">Update push credentials</h1>
 <div class="api_type"><div class="method post ">post</div>
 <p>/apps/push_credential/update</p>

docs/API/endpoints/catalogs/catalog_fields/asynchronous/delete_catalog_field/index.md

@@ -1,4 +1,4 @@
-<div id='api_hwzddbruahpg' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_aqdzcfrnalrq' class='api_div' data-search-keywords='delete catalog field message errors id parameters parameter_values'>
 <h1 id="delete-catalog-field">Delete catalog field</h1>
 <div class="api_type"><div class="method delete ">delete</div>
 <p>/catalogs/{catalog_name}/fields/{field_name}</p>

docs/API/endpoints/catalogs/catalog_fields/asynchronous/post_create_catalog_fields/index.md

@@ -1,4 +1,4 @@
-<div id='api_vitizpxqzmnh' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_ywsdvzasosup' class='api_div' data-search-keywords='create catalog fields message errors id parameters parameter_values'>
 <h1 id="create-catalog-fields">Create catalog fields</h1>
 <div class="api_type"><div class="method post ">post</div>
 <p>/catalogs/{catalog_name}/fields</p>

docs/API/endpoints/catalogs/catalog_items/asynchronous/delete_catalog_items_bulk/index.md

@@ -1,4 +1,4 @@
-<div id='api_ybuirynjlomw' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_ljxsqtzwshvr' class='api_div' data-search-keywords='delete multiple catalog items message errors id parameters parameter_values'>
 <h1 id="delete-multiple-catalog-items">Delete multiple catalog items</h1>
 <div class="api_type"><div class="method delete ">delete</div>
 <p>/catalogs/{catalog_name}/items</p>

docs/API/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk/index.md

@@ -1,4 +1,4 @@
-<div id='api_sxzjklnihbtr' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_hmpmiepbpdvp' class='api_div' data-search-keywords='edit multiple catalog items message errors id parameters parameter_values'>
 <h1 id="edit-multiple-catalog-items">Edit multiple catalog items</h1>
 <div class="api_type"><div class="method patch ">patch</div>
 <p>/catalogs/{catalog_name}/items</p>

docs/API/endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk/index.md

@@ -1,4 +1,4 @@
-<div id='api_lcxxxouopqza' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_afzghunhjoky' class='api_div' data-search-keywords='create multiple catalog items message errors id parameters parameter_values'>
 <h1 id="create-multiple-catalog-items">Create multiple catalog items</h1>
 <div class="api_type"><div class="method post ">post</div>
 <p>/catalogs/{catalog_name}/items</p>

docs/API/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/index.md

@@ -1,4 +1,4 @@
-<div id='api_vukduqvtlcby' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_vctxnvolbjaf' class='api_div' data-search-keywords='replace catalog items message errors id parameters parameter_values'>
 <h1 id="replace-catalog-items">Replace catalog items</h1>
 <div class="api_type"><div class="method put ">put</div>
 <p>/catalogs/{catalog_name}/items</p>

docs/API/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item/index.md

@@ -1,4 +1,4 @@
-<div id='api_jtdexbnorvry' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
+<div id='api_ezbsknpegqro' class='api_div' data-search-keywords='delete a catalog item message errors id parameters parameter_values'>
 <h1 id="delete-a-catalog-item">Delete a catalog item</h1>
 <div class="api_type"><div class="method delete ">delete</div>
 <p>/catalogs/{catalog_name}/items/{item_id}</p>