Skip to content

Commit 7335e88

Browse files
Mirror public docs markdown from braze.com/docs (2026-09-02) (#84)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 8e70af4 commit 7335e88

389 files changed

Lines changed: 9545 additions & 2814 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-09-02.md

Lines changed: 395 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
@@ -16,7 +16,7 @@ Because API campaigns always include a `campaign_id`, their sends are reflected
1616
**Warning:**
1717

1818

19-
Because API campaigns are typically transactional, all users are eligible for API campaigns, even those in your Global Control Group. A [one-click list-unsubscribe](https://www.braze.com/docs/user_guide/administrative/app_settings/email_settings#list-unsubscribe) header is not added to these sends by default. To add a one-click list-unsubscribe header to an API campaign, see [Add one-click list-unsubscribe to API campaigns](#add-one-click-list-unsubscribe-to-api-campaigns). To add a one-click list-unsubscribe header to all API campaigns, contact your customer success manager.
19+
Because API campaigns are typically transactional, all users are eligible for API campaigns, even those in your Global Control Group. A [one-click list-unsubscribe](https://www.braze.com/docs/user_guide/administer/global/workspace_settings/email_preferences) header is not added to these sends by default. To add a one-click list-unsubscribe header to an API campaign, see [Add one-click list-unsubscribe to API campaigns](#add-one-click-list-unsubscribe-to-api-campaigns). To add a one-click list-unsubscribe header to all API campaigns, contact your customer success manager.
2020

2121

2222

docs/API/api_limits/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ HTTP headers will be returned in all lowercase characters. This behavior aligns
199199

200200

201201

202-
If you have questions about API limits, contact your customer success manager or open a [support ticket](https://www.braze.com/docs/braze_support).
202+
If you have questions about API limits, contact your customer success manager or open a [support ticket](https://www.braze.com/docs/user_guide/administer/personal/braze_support).
203203

204204
**Tip:**
205205

docs/API/basics/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following is an overview of terms you may see in the Braze REST API document
2626

2727
### Endpoints
2828

29-
Braze manages a number of different instances for our dashboard and REST endpoints. When your account is provisioned, you log in to one of the following URLs. Use the correct REST endpoint based on which instance you are provisioned to. If you are unsure, open a [support ticket](https://www.braze.com/docs/braze_support) or use the following table to match the URL of the dashboard you use to the correct REST Endpoint.
29+
Braze manages a number of different instances for our dashboard and REST endpoints. When your account is provisioned, you log in to one of the following URLs. Use the correct REST endpoint based on which instance you are provisioned to. If you are unsure, open a [support ticket](https://www.braze.com/docs/user_guide/administer/personal/braze_support) or use the following table to match the URL of the dashboard you use to the correct REST Endpoint.
3030

3131
To find your REST endpoint in Braze:
3232

@@ -369,7 +369,7 @@ Given that REST API keys allow access to potentially sensitive REST API endpoint
369369

370370

371371

372-
If you accidentally expose a key, you can delete it from the Developer Console. For help with this process, open a [support ticket](https://www.braze.com/docs/braze_support).
372+
If you accidentally expose a key, you can delete it from the Developer Console. For help with this process, open a [support ticket](https://www.braze.com/docs/user_guide/administer/personal/braze_support).
373373

374374
### Security of REST API keys and SDK API keys
375375

@@ -393,7 +393,7 @@ If you don't specify any, requests can be sent from any IP address.
393393
**Tip:**
394394

395395

396-
If you're making a Braze-to-Braze webhook and using allowlisting, see the list of [IPs to whitelist](https://www.braze.com/docs/user_guide/message_building_by_channel/webhooks/creating_a_webhook#ip-whitelisting).
396+
If you're making a Braze-to-Braze webhook and using allowlisting, see the list of [IPs to whitelist](https://www.braze.com/docs/user_guide/channels/webhooks/create_a_webhook).
397397

398398

399399

docs/API/data_retention/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Data sent by Braze to certain subprocessors may still exist in Braze's internal
5454

5555
### Braze Data Lake Data Retention
5656

57-
Data available to Customers within the Braze dashboard is mostly aggregated. Detailed logs are kept in a separate database created by Braze (the "Data Lake"). Data Lake data is used for aggregate reporting and other advanced functionality. Braze removes personally identifiable information from events data stored in the Data Lake after two years (see more information in our [Snowflake Data Retention](https://www.braze.com/docs/partners/data_and_infrastructure_agility/data_warehouses/snowflake/data_retention#snowflake-data-retention) page).
57+
Data available to Customers within the Braze dashboard is mostly aggregated. Detailed logs are kept in a separate database created by Braze (the "Data Lake"). Data Lake data is used for aggregate reporting and other advanced functionality. Braze removes personally identifiable information from events data stored in the Data Lake after two years (see more information in our [Snowflake Data Retention](https://www.braze.com/docs/partners/data_and_analytics/data_warehouses/snowflake/data_retention) page).
5858

5959
If you use our APIs to delete user profiles or delete or amend attributes from user profiles, it may take up to three weeks for that data to be deleted from Braze's Data Lake. Deletion of data in the Data Lake will not affect segmentation or personalization but rather ensures the data is removed from all Braze systems.
6060

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_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'>
1+
<div id='api_cngnstphrjkj' 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'>
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_aqdzcfrnalrq' class='api_div' data-search-keywords='delete catalog field message errors id parameters parameter_values'>
1+
<div id='api_dhjeyrdfzwkv' class='api_div' data-search-keywords='delete catalog field 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_ywsdvzasosup' class='api_div' data-search-keywords='create catalog fields message errors id parameters parameter_values'>
1+
<div id='api_ycvrllitgvsw' class='api_div' data-search-keywords='create catalog fields 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_ljxsqtzwshvr' class='api_div' data-search-keywords='delete multiple catalog items message errors id parameters parameter_values'>
1+
<div id='api_dgxwcqrnnkni' class='api_div' data-search-keywords='delete multiple catalog items 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_hmpmiepbpdvp' class='api_div' data-search-keywords='edit multiple catalog items message errors id parameters parameter_values'>
1+
<div id='api_oqtqgqbuumvg' class='api_div' data-search-keywords='edit multiple catalog items 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>

0 commit comments

Comments
 (0)