Skip to content

Commit 3860ae8

Browse files
github-actions[bot]github-actions[bot]
authored
Mirror public docs markdown from braze.com/docs (2026-07-21) (#63)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 4a680d2 commit 3860ae8

167 files changed

Lines changed: 1282 additions & 970 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-07-21.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
# Daily docs markdown sync - 2026-07-21
2+
3+
## Summary
4+
- Source: https://www.braze.com/docs/sitemap.xml
5+
- Changed files: 166
6+
7+
## Changes
8+
- M `docs/API/api_limits/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/getting_started/platform_overview/index.md`
137+
- M `docs/Developer Guide/in_app_messages/customization/index.md`
138+
- M `docs/Developer Guide/push_notifications/index.md`
139+
- M `docs/Technology Partners/canvas_audience_sync/overview/index.md`
140+
- A `docs/Technology Partners/data_and_analytics/analytics/validity/index.md`
141+
- M `docs/Technology Partners/data_and_analytics/workflow_automation/mozart_data/index.md`
142+
- M `docs/Technology Partners/message_personalization/dynamic_content/visual_and_interactive_content/playable/index.md`
143+
- M `docs/User Guide/analytics/metrics_glossary/index.md`
144+
- M `docs/User Guide/audience/segments/segment_extension/sql_segments/use_cases/index.md`
145+
- M `docs/User Guide/brazeai/agents/examples/index.md`
146+
- M `docs/User Guide/brazeai/content_optimizer/index.md`
147+
- M `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/connect_data_sources/index.md`
148+
- M `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/design_your_agent/index.md`
149+
- A `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/examples/index.md`
150+
- A `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/faq/index.md`
151+
- M `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/index.md`
152+
- D `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/launch_your_agent/index.md`
153+
- D `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/set_up_orchestration/index.md`
154+
- A `docs/User Guide/brazeai/decisioning_studio/decisioning_studio_go/setup/index.md`
155+
- M `docs/User Guide/brazeai/decisioning_studio/get_started/index.md`
156+
- M `docs/User Guide/brazeai/decisioning_studio/orchestration_setup/index.md`
157+
- M `docs/User Guide/brazeai/intelligence_suite/intelligent_selection/index.md`
158+
- M `docs/User Guide/brazeai/intelligence_suite/intelligent_timing/index.md`
159+
- M `docs/User Guide/channels/email/reporting/analytics_glossary/index.md`
160+
- M `docs/User Guide/channels/sms_mms_and_rcs/compliance_and_delivery/best_practices/index.md`
161+
- M `docs/User Guide/channels/whatsapp/faq/index.md`
162+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/customer_behavior_events/index.md`
163+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/message_engagement_events/index.md`
164+
- M `docs/User Guide/data/distribution/braze_currents/event_glossary/user_profiles_events/index.md`
165+
- M `docs/User Guide/data/distribution/export_braze_data/export_troubleshooting/index.md`
166+
- M `docs/User Guide/data/distribution/export_braze_data/faqs/index.md`
167+
- M `docs/User Guide/messaging/canvas/canvas_components/content_optimizer_step/index.md`
168+
- M `docs/User Guide/messaging/design_and_edit/personalize/liquid/liquid_use_cases/index.md`
169+
- M `docs/User Guide/messaging/landing_pages/customize_the_url/index.md`
170+
- M `docs/User Guide/messaging/messaging_fundamentals/localization/locales_in_messages/index.md`
171+
- M `docs/User Guide/messaging/templates/email_templates/html_email_template/index.md`
172+
- M `docs/What's New/2026/5_28_26/index.md`
173+
- M `docs/What's New/home/index.md`

‎docs/API/api_limits/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Refer to the following for the default API rate limits of different request type
1919

2020
| Request Type | Default API Rate Limit |
2121
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22-
| [`/users/track`](https://www.braze.com/docs/api/endpoints/user_data/post_user_track) | **Requests:** 3,000 requests per three seconds.<br><br>**Batching:** Up to 75 total objects combined across `attributes`, `events`, and `purchases` per API request. Customers on legacy rate limits can include up to 75 objects per array independently. For more information, reference [Batching User Track requests](#batch-user-track).<br><br>**Limits for Monthly Active Users CY 24-25, Universal MAU, Web MAU, and Mobile MAU:** see [guidance on limits here](https://www.braze.com/docs/api/endpoints/user_data/post_user_track#monthly-active-users-cy-24-25-universal-mau-web-mau-and-mobile-mau). |
22+
| [`/users/track`](https://www.braze.com/docs/api/endpoints/user_data/post_user_track) | **Requests:** Rate limits vary depending on your contract. For customers with data points in their pricing, Braze applies a burst limit of 3,000 requests per three seconds. For all other customers, limits are configured according to your contract terms. Contact Braze Support or your customer success manager for questions about your limits.<br><br>**Batching:** Up to 75 total objects combined across `attributes`, `events`, and `purchases` per API request. Customers on legacy rate limits can include up to 75 objects per array independently. For more information, see [Batching User Track requests](#batch-user-track).<br><br>**Limits for Monthly Active Users CY 24-25, Universal MAU, Web MAU, and Mobile MAU:** See [Monthly Active Users CY 24-25 limits](https://www.braze.com/docs/api/endpoints/user_data/post_user_track#monthly-active-users-cy-24-25-universal-mau-web-mau-and-mobile-mau). |
2323
| [`/users/export/ids`](https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier) | **If you onboarded on or after August 22, 2024:** 250 requests per minute. <br><br> **If you onboarded before August 22, 2024:** 2,500 requests per minute. |
2424
| [`/users/delete`](https://www.braze.com/docs/api/endpoints/user_data/post_user_delete)<br>[`/users/alias/new`](https://www.braze.com/docs/api/endpoints/user_data/post_user_alias)<br>[`/users/alias/update`](https://www.braze.com/docs/api/endpoints/user_data/post_users_alias_update)<br>[`/users/identify`](https://www.braze.com/docs/api/endpoints/user_data/post_user_identify)<br>[`/users/merge`](https://www.braze.com/docs/api/endpoints/user_data/post_users_merge) | 20,000 requests per minute, shared between the endpoints. |
2525
| [`/users/external_id/rename`](https://www.braze.com/docs/api/endpoints/user_data/external_id_migration/post_external_ids_rename) | 1,000 requests per minute. |
@@ -128,7 +128,7 @@ REST API rate limit increases are considered based on need for customers who are
128128

129129

130130

131-
### Batching requests for Track users endpoint {#batch-user-track}
131+
### Batching requests for the Create and update users endpoint {#batch-user-track}
132132

133133
Each `/users/track` request can contain up to 75 total objects combined across `attributes`, `events`, and `purchases`. Each object can update one user. A single user profile can be updated by multiple objects.
134134

@@ -141,7 +141,7 @@ For customers on legacy rate limits, each array (`attributes`, `events`, and `pu
141141

142142
For more information about `/users/track` rate limits, see [POST: Create and update users](https://www.braze.com/docs/api/endpoints/user_data/post_user_track).
143143

144-
Requests made to this endpoint will generally begin processing in this order:
144+
Requests made to this endpoint generally begin processing in this order:
145145

146146
1. Attributes
147147
2. Events

0 commit comments

Comments
 (0)