Skip to content

Commit 1df4ba7

Browse files
Mirror public docs markdown from braze.com/docs (2026-08-11) (#74)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 49aeda9 commit 1df4ba7

148 files changed

Lines changed: 817 additions & 517 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

changes/2026-08-11.md

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
# Daily docs markdown sync - 2026-08-11
2+
3+
## Summary
4+
- Source: https://www.braze.com/docs/sitemap.xml
5+
- Changed files: 147
6+
7+
## Changes
8+
- M `docs/API/api_campaigns/index.md`
9+
- M `docs/API/endpoints/apps/post_update_push_credential/index.md`
10+
- M `docs/API/endpoints/catalogs/catalog_fields/asynchronous/delete_catalog_field/index.md`
11+
- M `docs/API/endpoints/catalogs/catalog_fields/asynchronous/post_create_catalog_fields/index.md`
12+
- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/delete_catalog_items_bulk/index.md`
13+
- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/patch_catalog_items_bulk/index.md`
14+
- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/post_create_catalog_items_bulk/index.md`
15+
- M `docs/API/endpoints/catalogs/catalog_items/asynchronous/put_update_catalog_items/index.md`
16+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/delete_catalog_item/index.md`
17+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/get_catalog_item_details/index.md`
18+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/get_catalog_items_details_bulk/index.md`
19+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/patch_catalog_item/index.md`
20+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/post_create_catalog_item/index.md`
21+
- M `docs/API/endpoints/catalogs/catalog_items/synchronous/put_update_catalog_item/index.md`
22+
- M `docs/API/endpoints/catalogs/catalog_management/synchronous/delete_catalog/index.md`
23+
- M `docs/API/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/index.md`
24+
- M `docs/API/endpoints/catalogs/catalog_management/synchronous/post_create_catalog/index.md`
25+
- M `docs/API/endpoints/catalogs/catalog_selections/asynchronous/delete_catalog_selection/index.md`
26+
- M `docs/API/endpoints/catalogs/catalog_selections/asynchronous/post_create_catalog_selections/index.md`
27+
- M `docs/API/endpoints/cdi/get_integration_list/index.md`
28+
- M `docs/API/endpoints/cdi/get_job_sync_status/index.md`
29+
- M `docs/API/endpoints/cdi/post_job_sync/index.md`
30+
- M `docs/API/endpoints/email/get_list_hard_bounces/index.md`
31+
- M `docs/API/endpoints/email/get_query_unsubscribed_email_addresses/index.md`
32+
- M `docs/API/endpoints/email/post_blacklist/index.md`
33+
- M `docs/API/endpoints/email/post_blocklist/index.md`
34+
- M `docs/API/endpoints/email/post_email_subscription_status/index.md`
35+
- M `docs/API/endpoints/email/post_remove_hard_bounces/index.md`
36+
- M `docs/API/endpoints/email/post_remove_spam/index.md`
37+
- M `docs/API/endpoints/export/campaigns/get_campaign_analytics/index.md`
38+
- M `docs/API/endpoints/export/campaigns/get_campaign_details/index.md`
39+
- M `docs/API/endpoints/export/campaigns/get_campaigns/index.md`
40+
- M `docs/API/endpoints/export/campaigns/get_send_analytics/index.md`
41+
- M `docs/API/endpoints/export/canvas/get_canvas_analytics/index.md`
42+
- M `docs/API/endpoints/export/canvas/get_canvas_analytics_summary/index.md`
43+
- M `docs/API/endpoints/export/canvas/get_canvas_details/index.md`
44+
- M `docs/API/endpoints/export/canvas/get_canvases/index.md`
45+
- M `docs/API/endpoints/export/custom_attributes/get_custom_attributes/index.md`
46+
- M `docs/API/endpoints/export/custom_events/get_custom_events/index.md`
47+
- M `docs/API/endpoints/export/custom_events/get_custom_events_analytics/index.md`
48+
- M `docs/API/endpoints/export/custom_events/get_custom_events_data/index.md`
49+
- M `docs/API/endpoints/export/kpi/get_kpi_daily_new_users_date/index.md`
50+
- M `docs/API/endpoints/export/kpi/get_kpi_dau_date/index.md`
51+
- M `docs/API/endpoints/export/kpi/get_kpi_mau_30_days/index.md`
52+
- M `docs/API/endpoints/export/kpi/get_kpi_uninstalls_date/index.md`
53+
- M `docs/API/endpoints/export/purchases/get_list_product_id/index.md`
54+
- M `docs/API/endpoints/export/purchases/get_number_of_purchases/index.md`
55+
- M `docs/API/endpoints/export/purchases/get_revenue_series/index.md`
56+
- M `docs/API/endpoints/export/segments/get_segment/index.md`
57+
- M `docs/API/endpoints/export/segments/get_segment_analytics/index.md`
58+
- M `docs/API/endpoints/export/segments/get_segment_details/index.md`
59+
- M `docs/API/endpoints/export/segments/post_cancel_export/index.md`
60+
- M `docs/API/endpoints/export/sessions/get_sessions_analytics/index.md`
61+
- M `docs/API/endpoints/export/user_data/post_users_global_control_group/index.md`
62+
- M `docs/API/endpoints/export/user_data/post_users_identifier/index.md`
63+
- M `docs/API/endpoints/export/user_data/post_users_segment/index.md`
64+
- M `docs/API/endpoints/media_library/manage_assets/create/index.md`
65+
- M `docs/API/endpoints/media_library/manage_assets/replace_file/index.md`
66+
- M `docs/API/endpoints/messaging/duplicate_messages/post_duplicate_campaigns/index.md`
67+
- M `docs/API/endpoints/messaging/duplicate_messages/post_duplicate_canvases/index.md`
68+
- M `docs/API/endpoints/messaging/live_activity/start/index.md`
69+
- M `docs/API/endpoints/messaging/live_activity/update/index.md`
70+
- M `docs/API/endpoints/messaging/schedule_messages/get_messages_scheduled/index.md`
71+
- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_messages/index.md`
72+
- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_canvases/index.md`
73+
- M `docs/API/endpoints/messaging/schedule_messages/post_delete_scheduled_triggered_messages/index.md`
74+
- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_messages/index.md`
75+
- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns/index.md`
76+
- M `docs/API/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases/index.md`
77+
- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_messages/index.md`
78+
- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_campaigns/index.md`
79+
- M `docs/API/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_canvases/index.md`
80+
- M `docs/API/endpoints/messaging/send_messages/post_create_send_ids/index.md`
81+
- M `docs/API/endpoints/messaging/send_messages/post_send_messages/index.md`
82+
- M `docs/API/endpoints/messaging/send_messages/post_send_transactional_message/index.md`
83+
- M `docs/API/endpoints/messaging/send_messages/post_send_triggered_campaigns/index.md`
84+
- M `docs/API/endpoints/messaging/send_messages/post_send_triggered_canvases/index.md`
85+
- M `docs/API/endpoints/preference_center/get_create_url_preference_center/index.md`
86+
- M `docs/API/endpoints/preference_center/get_list_preference_center/index.md`
87+
- M `docs/API/endpoints/preference_center/get_view_details_preference_center/index.md`
88+
- M `docs/API/endpoints/preference_center/post_create_preference_center/index.md`
89+
- M `docs/API/endpoints/preference_center/put_update_preference_center/index.md`
90+
- M `docs/API/endpoints/scim/delete_existing_dashboard_user/index.md`
91+
- M `docs/API/endpoints/scim/get_search_existing_dashboard_user/index.md`
92+
- M `docs/API/endpoints/scim/get_see_user_account_information/index.md`
93+
- M `docs/API/endpoints/scim/post_create_user_account/index.md`
94+
- M `docs/API/endpoints/scim/put_update_existing_user_account/index.md`
95+
- M `docs/API/endpoints/sdk_authentication/delete_sdk_authentication_key/index.md`
96+
- M `docs/API/endpoints/sdk_authentication/get_sdk_authentication_keys/index.md`
97+
- M `docs/API/endpoints/sdk_authentication/post_create_sdk_authentication_key/index.md`
98+
- M `docs/API/endpoints/sdk_authentication/put_primary_sdk_authentication_key/index.md`
99+
- M `docs/API/endpoints/sms/get_query_invalid_numbers/index.md`
100+
- M `docs/API/endpoints/sms/post_remove_invalid_numbers/index.md`
101+
- M `docs/API/endpoints/subscription_groups/get_list_user_subscription_group_status/index.md`
102+
- M `docs/API/endpoints/subscription_groups/get_list_user_subscription_groups/index.md`
103+
- M `docs/API/endpoints/subscription_groups/post_update_user_subscription_group_status/index.md`
104+
- M `docs/API/endpoints/subscription_groups/post_update_user_subscription_group_status_v2/index.md`
105+
- M `docs/API/endpoints/templates/content_blocks_templates/get_list_email_content_blocks/index.md`
106+
- M `docs/API/endpoints/templates/content_blocks_templates/get_see_email_content_blocks_information/index.md`
107+
- M `docs/API/endpoints/templates/content_blocks_templates/post_create_email_content_block/index.md`
108+
- M `docs/API/endpoints/templates/content_blocks_templates/post_update_content_block/index.md`
109+
- M `docs/API/endpoints/templates/email_templates/get_list_email_templates/index.md`
110+
- M `docs/API/endpoints/templates/email_templates/get_see_email_template_information/index.md`
111+
- M `docs/API/endpoints/templates/email_templates/post_create_email_template/index.md`
112+
- M `docs/API/endpoints/templates/email_templates/post_update_email_template/index.md`
113+
- M `docs/API/endpoints/translations/campaigns/get_source_campaign/index.md`
114+
- M `docs/API/endpoints/translations/campaigns/get_translation_campaign/index.md`
115+
- M `docs/API/endpoints/translations/campaigns/put_update_translation_campaign/index.md`
116+
- M `docs/API/endpoints/translations/canvas/get_source_canvas/index.md`
117+
- M `docs/API/endpoints/translations/canvas/get_translation_canvas/index.md`
118+
- M `docs/API/endpoints/translations/canvas/put_update_translation_canvas/index.md`
119+
- M `docs/API/endpoints/translations/content_blocks/get_source_content_block/index.md`
120+
- M `docs/API/endpoints/translations/content_blocks/get_translation_content_block/index.md`
121+
- M `docs/API/endpoints/translations/content_blocks/put_update_translation_content_block/index.md`
122+
- M `docs/API/endpoints/translations/email_templates/get_view_source_template/index.md`
123+
- M `docs/API/endpoints/translations/email_templates/get_view_translation_locale_template/index.md`
124+
- M `docs/API/endpoints/translations/email_templates/get_view_translation_template/index.md`
125+
- M `docs/API/endpoints/translations/email_templates/put_update_template/index.md`
126+
- M `docs/API/endpoints/user_data/external_id_migration/post_external_ids_remove/index.md`
127+
- M `docs/API/endpoints/user_data/external_id_migration/post_external_ids_rename/index.md`
128+
- M `docs/API/endpoints/user_data/post_user_alias/index.md`
129+
- M `docs/API/endpoints/user_data/post_user_delete/index.md`
130+
- M `docs/API/endpoints/user_data/post_user_identify/index.md`
131+
- M `docs/API/endpoints/user_data/post_user_track/index.md`
132+
- M `docs/API/endpoints/user_data/post_user_track_bulk/index.md`
133+
- M `docs/API/endpoints/user_data/post_user_track_synchronous/index.md`
134+
- M `docs/API/endpoints/user_data/post_users_alias_update/index.md`
135+
- M `docs/API/endpoints/user_data/post_users_merge/index.md`
136+
- M `docs/Developer Guide/changelogs/index.md`
137+
- M `docs/Developer Guide/getting_started/platform_overview/index.md`
138+
- M `docs/User Guide/administer/global/workspace_settings/email_preferences/bot_filtering/index.md`
139+
- M `docs/User Guide/analytics/dashboards/dashboard_builder/diagnostics_dashboard/index.md`
140+
- M `docs/User Guide/analytics/metrics_glossary/index.md`
141+
- M `docs/User Guide/audience/segments/segment_extension/sql_segments/use_cases/index.md`
142+
- M `docs/User Guide/brazeai/agents/examples/index.md`
143+
- M `docs/User Guide/brazeai/mcp_server/available_api_functions/index.md`
144+
- M `docs/User Guide/channels/email/email_setup/open_pixel_and_click_tracking/index.md`
145+
- M `docs/User Guide/channels/email/faq/index.md`
146+
- M `docs/User Guide/channels/email/reporting/analytics_glossary/index.md`
147+
- M `docs/User Guide/channels/in_app_messages/faq/index.md`
148+
- M `docs/User Guide/channels/kakaotalk/kakaotalk_setup/index.md`
149+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/customer_behavior_events/index.md`
150+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/message_engagement_events/index.md`
151+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/user_profiles_events/index.md`
152+
- M `docs/User Guide/messaging/canvas/faqs/index.md`
153+
- M `docs/User Guide/messaging/canvas/managing_canvases/canvas_threshold_alerts/index.md`
154+
- M `docs/User Guide/messaging/design_and_edit/personalize/liquid/liquid_use_cases/index.md`

docs/API/api_campaigns/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Send that information to your development team to use in the API request, along
1111

1212
After the campaign begins, you can view the results in the dashboard. API campaigns use the Braze [messaging APIs](https://www.braze.com/docs/api/endpoints/messaging), which have the same detailed reporting and retargeting options as campaigns created completely through the dashboard.
1313

14+
Because API campaigns always include a `campaign_id`, their sends are reflected in dashboard stats. If you call [`/messages/send`](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_messages) without a `campaign_id`, Braze doesn't increment those metrics—sends still appear in the [Message Activity Log](https://www.braze.com/docs/user_guide/administer/global/workspace_settings/logs_and_alerts/message_activity_log), but not in email performance metrics in the dashboard.
15+
1416
**Warning:**
1517

1618

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_taypzhevkvtb' 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'>
1+
<div id='api_evbmwrzvveun' 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'>
22
<h1 id="update-push-credentials">Update push credentials</h1>
33
<div class="api_type"><div class="method post ">post</div>
44
<p>/apps/push_credential/update</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_krgdvljbqunp' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_lzlaxybiqtto' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="delete-catalog-field">Delete catalog field</h1>
33
<div class="api_type"><div class="method delete ">delete</div>
44
<p>/catalogs/{catalog_name}/fields/{field_name}</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_gszpqszthwup' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_bqutadnouyhk' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="create-catalog-fields">Create catalog fields</h1>
33
<div class="api_type"><div class="method post ">post</div>
44
<p>/catalogs/{catalog_name}/fields</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_jblcumdrxkbc' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_gclogfhvrkwb' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="delete-multiple-catalog-items">Delete multiple catalog items</h1>
33
<div class="api_type"><div class="method delete ">delete</div>
44
<p>/catalogs/{catalog_name}/items</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_wpaxmexaykme' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_qkjnbwnqnhhr' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="edit-multiple-catalog-items">Edit multiple catalog items</h1>
33
<div class="api_type"><div class="method patch ">patch</div>
44
<p>/catalogs/{catalog_name}/items</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_abdoweetzkvn' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_ldrqgmyytnud' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="create-multiple-catalog-items">Create multiple catalog items</h1>
33
<div class="api_type"><div class="method post ">post</div>
44
<p>/catalogs/{catalog_name}/items</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_udzqsjtcgyup' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_kcrpawrefgij' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="replace-catalog-items">Replace catalog items</h1>
33
<div class="api_type"><div class="method put ">put</div>
44
<p>/catalogs/{catalog_name}/items</p>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_cousrhfdxurk' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_dunyqpnxcucs' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
22
<h1 id="delete-a-catalog-item">Delete a catalog item</h1>
33
<div class="api_type"><div class="method delete ">delete</div>
44
<p>/catalogs/{catalog_name}/items/{item_id}</p>

0 commit comments

Comments
 (0)