Skip to content

Commit 978e178

Browse files
Mirror public docs markdown from braze.com/docs (2026-07-16) (#60)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a0e95a3 commit 978e178

296 files changed

Lines changed: 1210 additions & 813 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-16.md

Lines changed: 302 additions & 0 deletions
Large diffs are not rendered by default.

docs/API/api_campaigns/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To configure your campaign, perform the following steps:
3636
## API calls
3737

3838
After you save your API campaign, include the following in your API request:
39-
- The generated `campaign_id` fields with your API request where noted in the [Send Messages Endpoints](https://www.braze.com/docs/api/endpoints/messaging#send-endpoints).
39+
- The generated `campaign_id` fields with your API request where noted in the [Send Messages Endpoints](https://www.braze.com/docs/api/endpoints/messaging).
4040
- A [message object](https://www.braze.com/docs/api/objects_filters#messaging-objects) for each platform included in the campaign. In the message object, provide the message variation ID. This specifies that statistics should be collected and displayed under that variant. The following message objects are supported: Android, Content Cards, email, iOS, Kindle, SMS/MMS, web push, and webhook.
4141

4242

docs/API/api_limits/index.md

Lines changed: 1 addition & 1 deletion
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). |
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). |
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. |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_nbosbdfcmtil' 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_xswdwgowrxcg' 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>
@@ -41,7 +41,7 @@
4141

4242
<h2 id="prerequisites">Prerequisites</h2>
4343

44-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">apps.push_credential</code> permission.</p>
44+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">apps.push_credential</code> permission.</p>
4545

4646
<h2 id="request-body">Request body</h2>
4747

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_dvgfnbxgjcdl' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_trgynaymnuph' 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>
@@ -10,7 +10,7 @@
1010

1111
<h2 id="prerequisites">Prerequisites</h2>
1212

13-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.delete_fields</code> permission.</p>
13+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.delete_fields</code> permission.</p>
1414

1515
<h2 id="rate-limit">Rate limit</h2>
1616

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_mmkrxojdxabv' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_hdvfuxojxnns' 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>
@@ -10,7 +10,7 @@
1010

1111
<h2 id="prerequisites">Prerequisites</h2>
1212

13-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.create_fields</code> permission.</p>
13+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.create_fields</code> permission.</p>
1414

1515
<h2 id="rate-limit">Rate limit</h2>
1616

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_xwinncquxjyj' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_srtohzexwrzc' 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>
@@ -14,7 +14,7 @@
1414

1515
<h2 id="prerequisites">Prerequisites</h2>
1616

17-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.delete_items</code> permission.</p>
17+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.delete_items</code> permission.</p>
1818

1919
<h2 id="rate-limit">Rate limit</h2>
2020

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_hfxtxbgjwqbi' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_hztafocupmpy' 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>
@@ -14,7 +14,7 @@
1414

1515
<h2 id="prerequisites">Prerequisites</h2>
1616

17-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.update_items</code> permission.</p>
17+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.update_items</code> permission.</p>
1818

1919
<h2 id="rate-limit">Rate limit</h2>
2020

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_hnkxzphwynyw' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_jephuaiihuij' 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>
@@ -14,7 +14,7 @@
1414

1515
<h2 id="prerequisites">Prerequisites</h2>
1616

17-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.add_items</code> permission.</p>
17+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.add_items</code> permission.</p>
1818

1919
<h2 id="rate-limit">Rate limit</h2>
2020

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id='api_lfcyczdsizqs' class='api_div' data-search-keywords='prerequisites message errors id parameters parameter_values'>
1+
<div id='api_pnyshjthtfbc' 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>
@@ -14,7 +14,7 @@
1414

1515
<h2 id="prerequisites">Prerequisites</h2>
1616

17-
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.replace_items</code> permission.</p>
17+
<p>To use this endpoint, you’ll need an <a href="/docs/api/basics#rest-api-key-permissions">API key</a> with the <code class="language-plaintext highlighter-rouge">catalogs.replace_items</code> permission.</p>
1818

1919
<h2 id="rate-limit">Rate limit</h2>
2020

@@ -144,7 +144,7 @@
144144

145145
<p><strong>Note:</strong></p>
146146

147-
<p>The system can also return a <code class="language-plaintext highlighter-rouge">400</code> response if your company has reached its catalog storage limit. The free version of catalogs is capped at 100 MB. For more information about storage tiers and how to upgrade, see <a href="/docs/user_guide/data/activation/catalogs#data-storage-limitations">Data storage limitations</a>.</p>
147+
<p>The system can also return a <code class="language-plaintext highlighter-rouge">400</code> response if your company has reached its catalog storage limit. The free version of catalogs is capped at 500 MB. For more information about storage tiers and how to upgrade, see <a href="/docs/user_guide/data/activation/catalogs#data-storage-limitations">Data storage limitations</a>.</p>
148148

149149
<h3 id="example-success-response">Example success response</h3>
150150

0 commit comments

Comments
 (0)