Braze Docs

https://github.com/braze-inc/braze-docs
Admin
Braze Docs hosts all user, developer, partner, and API documentation for the Braze customer...
Tokens:3,683,859
Snippets:26,033
Trust Score:9.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies and start Metro

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/sdk_repository_guides/react_native.md

Commands to install dependencies and start the React Native development server for the sample app.

```bash
cd BrazeProject/
yarn install
npx react-native start
```

--------------------------------

### GET /purchases/product_list Example Response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/purchases/get_list_product_id.md

Example response from the /purchases/product_list endpoint. Contains a list of product names and a message indicating success.

```json
{
  "products": [
    "product_name" (string), the name of the product
  ],
  "message": (string) returns 'success' when the request completes without errors
}
```

--------------------------------

### Use dev_guide layout

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/yaml_front_matter/page_layouts.md

Applies the developer guide format. Example applied to the Catalogs Endpoints page.

```markdown
---
layout: dev_guide
---
```

--------------------------------

### GET /purchases/product_list Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/purchases/get_list_product_id.md

Example request to the /purchases/product_list endpoint. The page parameter is optional and specifies the page of the product list to view.

```http
https://rest.iad-01.braze.com/purchases/product_list?page=1
```

--------------------------------

### GET /users/subscription - Example Response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/email/get_query_by_email_or_phone.md

Example response from the GET /users/subscription endpoint. Entries are listed in descending order. The response includes email subscription state, subscription group details, and phone subscription information.

```json
{
  "emails": [
    {
      "email": "example@example.com",
      "email_subscribe": {
        "email_subscription_event_date": "2019-11-20T19:58:04.825Z",
        "email_subscription_state": "Subscribed"
      },
      "subscription_group": [
        {
          "subscription_group_id": "5f5536d2a76e0f4e323a1234",
          "subscription_group_event_date": "2021-03-11T21:29:22.347Z",
          "subscription_group_state": "Unsubscribed"
        }
      ],
      "hard_bounced_at": null,
      "spam_at": null
    }
  ],
	"phone": [{
		"phone": "+12123355555",
		"subscription_group": [{
			"subscription_group_id": "3f5536d2a76e0f4e323a5555",
			"subscription_group_state": "Subsscribed",
			"subscription_group_event_date": "2021-03-11T21:29:22.347Z"
		}]
	}],
	"message": "success"
}
```

--------------------------------

### Install Hello Braze sample app

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/references.md

Installs the Hello Braze sample app to a device or emulator. If ANDROID_HOME is not set or local.properties lacks a valid sdk.dir, the plugin installs the base SDK automatically.

```bash
./gradlew installDebug
```

--------------------------------

### Get user properties - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get user properties endpoint. Contains amp_props with library, first_used, last_used, and example properties.

```json
{
  "userData": {
    "recommendations": null,
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": {
      "library": "http/1.0",
      "first_used": "2020-01-13",
      "last_used": "2021-03-24",
      "number_property": 12,
      "boolean_property": true
    },
    "cohort_ids": null
  }
}
```

--------------------------------

### GET /users/subscription - Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/email/get_query_by_email_or_phone.md

Use this GET request to retrieve subscription state for a user by email and phone. Replace YOUR_REST_API_KEY with your actual API key. The endpoint requires both email and phone parameters.

```bash
curl --location --request GET 'https://rest.iad-01.braze.com/users/subscriptions?phone=+12123355555&email=example%40braze.com' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'
```

--------------------------------

### Using placeholders examples

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/style_guide/writing_style_guide.md

Examples of how to introduce and explain placeholders. Call out placeholders immediately after they appear, use bulleted lists for multiple placeholders, and refer to placeholders in the same formatting as shown in the code.

```text
Replace <YOUR_APP_IDENTIFIER_API_KEY> with your App Identifier API Key, which you can find on the Settings page.
```

```text
Replace the following:
- PLACEHOLDER_VARIABLE: a description of what the placeholder represents
- PLACEHOLDER_VARIABLE: a description of what the placeholder represents
```

```ruby
target <YOUR_APP_TARGET> do pod 'Appboy-iOS-SDK' end
```

```text
Replace <YOUR_APP_TARGET> with the name of your target app.
```

--------------------------------

### Example request: Start Live Activity with curl

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/messaging/live_activity/start.md

Use this curl command to start a Live Activity. Replace {YOUR_REST_API_KEY} with your actual API key. The request body includes fields like app_id, activity_id, content_state, activity_attributes_type, activity_attributes, stale_date, notification, external_user_ids, and user_aliases. The endpoint is POST https://rest.iad-01.braze.com/messages/live_activity/start.

```bash
curl --location --request POST 'https://rest.iad-01.braze.com/messages/live_activity/start' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR_REST_API_KEY}' \
--data-raw '{
  "app_id": "{YOUR_APP_API_IDENTIFIER}",
  "activity_id": "football-chiefs-bills-2024-01-21",
  "content_state": {
    "teamOneScore": 0,
    "teamTwoScore": 0
  },
  "activity_attributes_type": "FootballActivity",
  "activity_attributes": {
    "team1Name": "Chiefs",
    "team2Name": "Bills"
  },
  "stale_date": "2024-01-22T16:55:49+0000",
  "notification": {
    "alert": {
      "body": "The game is starting! Tune in soon!",
      "title": "Chiefs v. Bills"
    }
  },
  "external_user_ids": ["user-id1", "user-id2"],
  "user_aliases": [
    {
      "alias_name": "user-name",
      "alias_label": "user-label"
    }
  ]
}'
```

--------------------------------

### How-to guide header syntax example

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_types.md

H2 headers should be action-oriented and reflect the general goal for the step. Optional steps are prepended with '(Optional)'.

```markdown
## Creating a page

1. Open the relevant directory in `braze-docs`.
2. Create a new Markdown file for your page.
3. Use a filename that follows our [naming guidelines](#naming-guidelines).
4. (Optional) You can generate a preview by running `rake` in your terminal.
```

--------------------------------

### GET /kpi/uninstalls/data_series - Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/kpi/get_kpi_uninstalls_date.md

Example request to retrieve daily uninstalls for the last 14 days ending at the specified date. Requires an API key with the `kpi.uninstalls.data_series` permission. The `app_id` parameter is optional; if omitted, results for all apps in the workspace are returned.

```curl
curl --location -g --request GET 'https://rest.iad-01.braze.com/kpi/uninstalls/data_series?length=14&ending_at=2018-06-28T23:59:59-5:00&app_id={{app_identifier}}' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
```

--------------------------------

### GET /preference_center/v1/list - Example Response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/preference_center/get_list_preference_center.md

Example JSON response from the list preference centers endpoint. It contains an array of preference centers with name, preference_center_api_id, created_at, and updated_at fields.

```json
{
  "preference_centers": [
    {
      "name": "My Preference Center 1",
      "preference_center_api_id": "preference_center_api_id",
      "created_at": "2022-08-17T15:46:10Z",
      "updated_at": "2022-08-17T15:46:10Z"
    },
    {
      "name": "My Preference Center 2",
      "preference_center_api_id": "preference_center_api_id",
      "created_at": "2022-08-19T11:13:06Z",
      "updated_at": "2022-08-19T11:13:06Z"
    },
    {
      "name": "My Preference Center 3",
      "preference_center_api_id": "preference_center_api_id",
      "created_at": "2022-08-19T11:30:50Z",
      "updated_at": "2022-08-19T11:30:50Z"
    },
    {
      "name": "My Preference Center 4",
      "preference_center_api_id": "preference_center_api_id",
      "created_at": "2022-09-13T20:41:34Z",
      "updated_at": "2022-09-13T20:41:34Z"
    }
  ]
}
```

--------------------------------

### Install Braze Vega SDK with yarn

Source: https://github.com/braze-inc/braze-docs/blob/develop/_includes/developer_guide/vega/sdk_integration.md

Install the Braze Vega SDK using yarn. After installation, import the required methods.

```bash
yarn add @braze/vega-sdk
```

```javascript
import { initialize, changeUser, openSession } from "@braze/vega-sdk";
```

--------------------------------

### GET /kpi/uninstalls/data_series - Example Response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/kpi/get_kpi_uninstalls_date.md

Example response structure for the daily uninstalls endpoint. The response includes a message field and a data array with each entry containing the date and the number of uninstalls.

```json
{
    "message": (string) returns 'success' when the request completes without errors,
    "data" : [
        {
            "time" : (string) the date as ISO 8601 date,
            "uninstalls" : (int) the number of uninstalls
        },
        ...
    ]
}
```

--------------------------------

### GET /campaigns/translations/source - Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/translations/campaigns/get_source_campaign.md

Example request to view default source values for a campaign's translation tags. Requires an API key with the `campaigns.translations.get` permission. The `post_launch_draft_version` query parameter is set to `true` to return the latest draft version instead of the live version.

```bash
curl --location --request GET 'https://rest.iad-03.braze.com/campaigns/translations/source?campaign_id={campaign_id}&message_variation_id={message_variation_id}&locale_id={locale_uuid}&post_launch_draft_version=true' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
```

--------------------------------

### Example include content (Markdown)

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management/reusing_content.md

Example content for an include file. Do not add YAML front matter if the include will be used on a page that already has front matter. Follow the Braze Docs Style Guide.

```markdown
## Site generator 

Braze Docs is built using Jekyll, a popular static-site generator (SSG) that allows content files and design files to be stored in separate directories, such as `_docs` for content files and `assets` for design files. When the site is built, Jekyll intelligently merges each file and stores them as XML and HTML data in the `_site` directory. For more information, see [Jekyll Directory Structure](https://jekyllrb.com/docs/structure/).

![The home page for Braze Docs.](../../../assets/img/contributing/braze_docs_github.png)

As a contributor, you'll primarily work within the following directories.

| Directory                                                                     | Description                                                                                                                                                                                                                                                                                                                       |
|-------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`_docs`](https://github.com/braze-inc/braze-docs/tree/develop/_docs)         | Contains all the written content for Braze Docs as text files written in Markdown. Text files are organized into directories and subdirectories mirroring the docs site, such as `_api` for the [API section](https://www.braze.com/docs/api/home) and `user_guide` for the [User Guide section](https://www.braze.com/docs/user_guide/home). |
| [`_includes`](https://github.com/braze-inc/braze-docs/tree/develop/_includes) | Contains text files (called "includes") that can be reused in any file within the `_docs` directory. Typically, includes are short, modular pieces of content that don't use standard formatting. The files stored in this location are important for [content reuse](#content-reuse).                                            |
| [`assets`](https://github.com/braze-inc/braze-docs/tree/develop/assets)       | Contains all the images for Braze Docs. Any text file in the `_docs` or `_includes` directory can link to this directory to display an image on its page.                                                                                                                                                                         |

```
```

--------------------------------

### Products variable usage and example

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_user_guide/analytics/reports/query_builder/sql_variables.md

Usage and example for the products variable. The usage shows the syntax with a custom label, and the example demonstrates selecting products with a specific label in a WHERE clause.

```sql
({{products.${custom_label}}})
```

```sql
SELECT product_name
FROM FULL_GAME_AND_DLC
WHERE product_id IN ({{products.${Games with DLC}}});
```

--------------------------------

### Flutter - TypeScript: Set device alias and start tracking

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/message_orchestration/attribution/airbridge.md

Uses BrazePlugin to get the install tracking ID, then sets it as an alias on Airbridge and starts tracking.

```TypeScript
BrazePlugin.getInstallTrackingId().then((brazeID) {
    Airbridge.state.setDeviceAlias("braze_device_id", brazeID)
  Airbridge.state.startTracking()
})
```

--------------------------------

### Run sync_sdk_repository_guides.py with --write and --check

Source: https://github.com/braze-inc/braze-docs/blob/develop/scripts/sdk_repository_guides_sync_internal.md

Run from the repository root to write and then check the SDK repository guides. The --write flag generates the guides, and --check verifies them.

```bash
python3 scripts/sync_sdk_repository_guides.py --write
python3 scripts/sync_sdk_repository_guides.py --check
```

--------------------------------

### Service account export setup

Source: https://github.com/braze-inc/braze-docs/blob/develop/scripts/tam-solutions/README.md

Sets environment variables, installs dependencies, and runs the export script using a service account. Requires GOOGLE_APPLICATION_CREDENTIALS pointing to the service account JSON key and TAM_SOLUTIONS_EXPORT_ACKNOWLEDGE_SENSITIVE_DATA=1.

```bash
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"
export TAM_SOLUTIONS_EXPORT_ACKNOWLEDGE_SENSITIVE_DATA=1
pip install google-api-python-client google-auth
python3 scripts/tam-solutions/export_drive_solutions.py
```

--------------------------------

### Install Braze Vega SDK with npm

Source: https://github.com/braze-inc/braze-docs/blob/develop/_includes/developer_guide/vega/sdk_integration.md

Install the Braze Vega SDK using npm. After installation, import the required methods.

```bash
npm install @braze/vega-sdk --save
```

```javascript
import { initialize, changeUser, openSession } from "@braze/vega-sdk";
```

--------------------------------

### Example directory structure for a section

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management/sections.md

Shows an example directory structure for a section named 'getting_started' under the 'platform_wide' subsection. The directory and file names match as required.

```plaintext
braze-docs
└── _docs
    └── _developer_guide 
        └── platform_wide 
            ├── getting_started 
            └── getting_started.md
```

--------------------------------

### Unity - C#: Set device alias and start tracking

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/message_orchestration/attribution/airbridge.md

Gets the Braze install tracking ID via AppboyBinding, sets it as an alias on Airbridge, and starts tracking.

```C#
string BrazeID = AppboyBinding.GetInstallTrackingId();
AirbridgeUnity.SetDeviceAlias("braze_device_id", BrazeID);
AirbridgeUnity.StartTracking()
```

--------------------------------

### Example: Change to the braze-docs directory

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/your_first_contribution.md

Example command showing the path format used when changing into the repo directory.

```bash
cd ~/braze/braze-docs
```

--------------------------------

### React Native - TypeScript: Set device alias and start tracking

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/message_orchestration/attribution/airbridge.md

Gets the Braze install tracking ID and sets it as a device alias on Airbridge, then starts tracking.

```TypeScript
Braze.getInstallTrackingId(function (error, brazeID) {
    Airbridge.state.setDeviceAlias("braze_device_id", brazeID)
    Airbirdge.state.startTracking()
})
```

--------------------------------

### OAuth export setup

Source: https://github.com/braze-inc/braze-docs/blob/develop/scripts/tam-solutions/README.md

Sets the required environment variable, installs OAuth dependencies, and runs the export script with the --oauth flag. Requires an OAuth Desktop client saved as scripts/tam-solutions/oauth_client_secret.json; the token is stored in scripts/tam-solutions/.oauth_token.json (gitignored).

```bash
export TAM_SOLUTIONS_EXPORT_ACKNOWLEDGE_SENSITIVE_DATA=1
pip install google-api-python-client google-auth google-auth-oauthlib
python3 scripts/tam-solutions/export_drive_solutions.py --oauth
```

--------------------------------

### Example subsection page without landing page

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management/sections.md

Example of a subsection page without a landing page, showing the nav_title set to 'Getting started', page_order 2, noindex true, and config_only true. This is the expected structure after replacing NAV_TITLE.

```markdown
---
nav_title: Getting started
page_order: 2
noindex: true
config_only: true
---

```

--------------------------------

### Placeholder text formatting examples

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/style_guide/writing_style_guide.md

Examples of placeholder text formatting from the writing style guide. Use uppercase letters with underscores for placeholders, italics for inline text, curly brackets for API code blocks, and uppercase for Liquid code blocks. The examples show recommended and discouraged placeholder names.

```text
PLACEHOLDER_VARIABLE
```

```markdown
*`PLACEHOLDER_VARIABLE`*
```

```xml
<string name="com_appboy_api_key">{YOUR_APP_IDENTIFIER_API_KEY}</string>
```

```liquid
{%- connected_content YOUR-API-URL :save items -%}
```

```text
CAMPAIGN_NAME
```

```text
NAME
```

--------------------------------

### Set up repository for locale preview

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/locale_preview_testing.md

Run once per terminal session or when switching branches to set up the repository before building a locale preview.

```bash
cd ~/braze-docs
git checkout YOUR_BRANCH_NAME
```

--------------------------------

### Get cohort IDs - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get cohort IDs endpoint. Contains a cohort_ids array with example cohort identifiers.

```json
{
  "userData": {
    "recommendations": null,
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": null,
    "cohort_ids": ["cohort1", "cohort3", "cohort7"]
  }
}
```

--------------------------------

### Get all computations - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get all computations endpoint. Contains amp_props with multiple computed properties and their values.

```json
{
  "userData": {
    "recommendations": null,
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": {
      "computed-prop-1": "5000000.0",
      "computed-prop-2": "3"
    },
    "cohort_ids": null
  }
}
```

--------------------------------

### Setup Experiment Tracking in didFinishLaunchingWithOptions

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_releases/deprecations/apptimize.md

Call this method after initializing both Appboy and Apptimize to begin tracking experiment enrollment and participation.

```objc
[ApptimizeAppboy setupExperimentTracking];
```

--------------------------------

### Get a single computation - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get a single computation endpoint. Contains amp_props with a computed property and its value.

```json
{
  "userData": {
    "recommendations": null,
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": {
      "computed-prop-2": "3"
    },
    "cohort_ids": null
  }
}
```

--------------------------------

### Start a local server with rake

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/generating_a_preview.md

Start a local server using your current branch. Run `rake` for English, or `rake es`, `rake fr`, `rake ja`, `rake ko`, or `rake pt_br` for other languages. Prepending `MARKDOWN_API=true` lets you preview content within a `{% markdown_embed %}` tag. The output shows the server starting on port 4000.

```bash
# for 'en' language:
rake

# for other languages:
rake es
rake fr
rake ja
rake ko
rake pt_br

# to render content in '{% markdown_embed %}' tags (e.g. Developer Guide changelogs):
MARKDOWN_API=true rake
```

```bash
== Sinatra (v3.0.4) has taken the stage on 4000 for development with backup from Puma
Puma starting in single mode...
* Puma version: 6.3.1 (ruby 3.2.2-p225) ("Mugi No Toki Itaru")
*  Min threads: 8
*  Max threads: 32
*  Environment: development
*          PID: 16158
* Listening on http://127.0.0.1:4000
...
```

--------------------------------

### Get multiple recommendations - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get multiple recommendations endpoint. Contains a recommendations array with two items, each with its own rec_id, items list, and metadata.

```json
{
  "userData": {
    "recommendations": [
      {
        "rec_id": "testRecId",
        "child_rec_id": "testRecId",
        "items": [
          "cookie",
          "cracker",
          "chocolate milk",
          "donut",
          "croissant"
        ],
        "is_control": false,
        "recommendation_source": "model",
        "last_updated": 1608670720
      },
            {
        "rec_id": "testRecId2",
        "child_rec_id": "testRecId2",
        "items": [
          "bulgogi",
          "bibimbap",
          "kimchi",
          "croffles",
          "samgyeopsal"
        ],
        "is_control": false,
        "recommendation_source": "model2",
        "last_updated": 1608670658
      }
    ],
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": null,
    "cohort_ids": null
  }
}
```

--------------------------------

### Get a recommendation - Example response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/data_and_analytics/customer_data_platform/amplitude/amplitude_user_profile_api.md

Example JSON response for the get a recommendation endpoint. Contains a recommendations array with one item, including the rec_id, child_rec_id, items list, and metadata.

```json
{
  "userData": {
    "recommendations": [
      {
        "rec_id": "testRecId",
        "child_rec_id": "testRecId",
        "items": [
          "cookie",
          "cracker",
          "chocolate milk",
          "donut",
          "croissant"
        ],
        "is_control": false,
        "recommendation_source": "model",
        "last_updated": 1608670720
      }
    ],
    "user_id": "testUser",
    "device_id": "ffff-ffff-ffff-ffff",
    "amp_props": null,
    "cohort_ids": null
  }
}
```

--------------------------------

### GET /preference_center/v1/list - Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/preference_center/get_list_preference_center.md

Use this curl command to list your available preference centers. Replace YOUR-REST-API-KEY with your actual API key. The endpoint requires the preference_center.list permission.

```bash
curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/list \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
```

--------------------------------

### Build and serve English locale

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/locale_preview_testing.md

Builds the English locale and starts the preview server. Run this block, open the preview URLs, run the verification checklists, then stop the server before continuing to the next locale.

```bash
bundle exec rake docs_en:build_fast
rake
```

--------------------------------

### Example layout usage with file tree and in-page metadata

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management.md

Shows a file tree with an `api_page.html` layout in the `_layouts` directory, and the front matter needed to use it. This example is from the 'Example input' section.

```plaintext
braze-docs
└── _layouts
    └── api_page.html
```

```markdown
---
layout: api_page
---
```

--------------------------------

### Template for a tutorial markdown page

Source: https://github.com/braze-inc/braze-docs/blob/develop/_lang/ja/_includes/contributing/templates/tutorial.md

Use this template to start a new tutorial page in the Braze Docs. Replace the placeholders (NAV_TITLE, DESCRIPTION, etc.) with your content initially, then follow the comments to fill in the introduction, objectives, and other sections.

```markdown
---
nav_title: NAV_TITLE
article_title: Tutorial: WHAT_THE_USER_WILL_DO
description: "SHORT_DESCRIPTION."
alias: /OPTIONAL_SHORT_ARTICLE_TITLE/
page_type: tutorial
layout: OPTIONAL_LAYOUT_FILE
---

# Tutorial: WHAT_THE_USER_WILL_DO

<!-- The overview starts with a '>' character and discusses what will be covered. In an optional following paragraph, contextualize the topic at a high-level in an introduction. -->
> DESCRIPTION.

INTRODUCTION.

<!-- Introduce the tutorial with the following format:-->
When you’re finished with this tutorial, you’ll be able to:

- LEARNING_OBJECTIVE
- LEARNING_OBJECTIVE
- LEARNING_OBJECTIVE

<!-- Replace each `LEARNING_OBJECTIVE` with something the user will broadly learn how to do during the tutorial. For example, a tutorial that walks a user through creating their first contribution to the Braze Docs site might have the following objectives:-->

- Navigate the Braze Docs GitHub repository
- Make changes using the GitHub website or your local environment
- Create pull requests (PRs)
- Preview your changes in a test site
- Request a review from the Braze Docs team
```

--------------------------------

### GET /sms/invalid_phone_numbers

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/sms/get_query_invalid_numbers.md

This code snippet documents the GET /sms/invalid_phone_numbers endpoint, including its parameters, example request, and response format.

```APIDOC
## GET /sms/invalid_phone_numbers

### Description
Use this endpoint to pull a list of phone numbers that have been marked "invalid" within a certain time frame.

### Method
GET

### Endpoint
/sms/invalid_phone_numbers

### Parameters
#### Query Parameters
- **start_date** (String in YYYY-MM-DD format) - Optional (see note) - Start date of the range to retrieve invalid phone numbers, must be earlier than `end_date`. This is treated as midnight in UTC time by the API.
- **end_date** (String in YYYY-MM-DD format) - Optional (see note) - End date of the range to retrieve invalid phone numbers. This is treated as midnight in UTC time by the API. Results include invalid numbers detected through the end of this calendar day in UTC (inclusive).
- **limit** (Integer) - Optional - Limit the number of results returned. Defaults to 100, maximum is 500.
- **offset** (Integer) - Optional - Beginning point in the list to retrieve from.
- **phone_numbers** (Array of Strings in e.164 format) - Optional (see note) - If provided, Braze returns the phone number if it has been found to be invalid.
- **reason** (String) - Optional (see note) - Available values are `provider_error` (the provider indicates the phone cannot receive SMS), `deactivated` (the phone number has been deactivated), or `invalid_format` (the number failed formatting validation, such as a non-E.164 value). If omitted, all reasons are returned.

### Note
You must provide either a `start_date` and an `end_date` OR `phone_numbers`. If you provide all three, `start_date`, `end_date`, and `phone_numbers`, we prioritize the given phone numbers and disregard the date range.

If your date range has more than the `limit` number of invalid phone numbers, you will need to make multiple API calls with increasing the `offset` each time until a call returns either fewer than `limit` or zero results.

### Request Example
```
curl --location --request GET 'https://rest.iad-01.braze.com/sms/invalid_phone_numbers?start_date=2019-01-01&end_date=2019-02-01&limit=100&offset=1&phone_numbers[]=12345678901' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'
```

### Response
Entries are listed in descending order.

#### Response Example
```json
{
  "sms": [
    {
      "phone": "(string) phone number in e.164 format",
      "invalid_detected_at": "(string) the time the invalid number was detected in ISO 8601",
      "reason": "provider_error"
    },
    {
      "phone": "(string) phone number in e.164 format",
      "invalid_detected_at": "(string) the time the invalid number was detected in ISO 8601",
      "reason": "deactivated"
    },
    {
      "phone": "(string) phone number in e.164 format",
      "invalid_detected_at": "(string) the time the invalid number was detected in ISO 8601",
      "reason": "invalid_format"
    }
  ],
  "message": "success"
}
```
```

--------------------------------

### Install project dependencies

Source: https://github.com/braze-inc/braze-docs/blob/develop/README.md

Install project dependencies using Bundler and asdf.

```bash
bundle install && asdf install
```

--------------------------------

### Prepare temporary directory for XCFrameworks

Source: https://github.com/braze-inc/braze-docs/blob/develop/_includes/developer_guide/swift/sdk_integration.md

These directory listings show the expected contents of the temporary directory after moving the required BrazeKit framework and then after moving each of the chosen XCFrameworks. The first listing is the minimal setup with only BrazeKit, while the second includes additional frameworks such as BrazeKitCompat, BrazeLocation, and SDWebImage.

```bash
temp_dir
└── BrazeKit.xcframework
```

```bash
temp_dir
├── BrazeKit.xcframework
├── BrazeKitCompat.xcframework
├── BrazeLocation.xcframework
└── SDWebImage.xcframework
```

--------------------------------

### GET /subscription/user/status - Multiple Users Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/subscription_groups/get_list_user_subscription_groups.md

Example request for multiple users using external_id parameters. The endpoint is GET /subscription/user/status.

```url
https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=2
```

--------------------------------

### Correct User-Agent example

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/isv_partners/api_partner.md

Correct example of a User-Agent header for Snowflake's Cloud Data Ingestion.

```bash
User-Agent: partner-Snowflake
```

--------------------------------

### Start local server with rake

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/your_first_contribution.md

Run these commands in the terminal to start a local server for previewing your changes. The output will be similar to the Sinatra/Puma server startup message.

```bash
cd ~/braze-docs
rake
```

--------------------------------

### Create a commit and view output

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/your_first_contribution.md

Example of a commit command and the resulting output message.

```bash
$ git commit -m "Fixing a typo in the recommended software doc"
[fixing-typo-in-recommended-software 8b05e34] Fixing a typo in the recommended software doc.
 1 file changed, 1 insertion(+), 1 deletion(-)
```

--------------------------------

### GET /canvas/data_summary

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/canvas/get_canvas_analytics_summary.md

This snippet documents the GET /canvas/data_summary endpoint, including its query parameters, request example, and response structure for conversion event fields.

```APIDOC
## GET /canvas/data_summary

### Description
Retrieves a summary of analytics for a Canvas, including conversion events, variant breakdowns, and step breakdowns.

### Method
GET

### Endpoint
`https://rest.iad-01.braze.com/canvas/data_summary`

### Parameters
#### Query Parameters
- **canvas_id** (string) - Required - The Canvas identifier.
- **ending_at** (string) - Required - The end date/time of the data range in ISO 8601 format.
- **starting_at** (string) - Required - The start date/time of the data range in ISO 8601 format.
- **length** (integer) - Required - The number of data points to return.
- **include_variant_breakdown** (boolean) - Optional - Whether to include variant breakdowns.
- **include_step_breakdown** (boolean) - Optional - Whether to include step breakdowns.
- **include_deleted_step_data** (boolean) - Optional - Whether to include data for deleted steps.

### Request Example
```
curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-05:00&starting_at=2018-05-28T23:59:59-05:00&length=5&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=true' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
```

### Response
#### Success Response (200)
The response includes conversion event fields. For each conversion event configured on the Canvas, there is a pair of fields: one for conversions and one for conversions by entry time. The primary conversion event uses `conversions` and `conversions_by_entry_time`. Additional events use numeric suffixes starting at `1` (e.g., `conversions1`, `conversions1_by_entry_time`). These fields appear in `total_stats`, and when breakdowns are requested, in `variant_stats` and `step_stats`.

#### Response Example
No explicit response example is provided in the source.

```

--------------------------------

### Prompt: Initialize Braze Web SDK

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/getting_started/build_with_llm.md

Prompt for Context7 to show how to initialize the Braze Web SDK with braze.initialize(), including API key, base URL, and options for logging and automatic in-app message display.

```text
Using the Braze Web SDK, show me how to initialize the SDK with 
braze.initialize(), including the API key, base URL, and options 
for enabling logging and automatic in-app message display. 
Use context7.
```

--------------------------------

### Cordova - TypeScript: Set device alias and start tracking

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/message_orchestration/attribution/airbridge.md

Gets the Braze device ID via AppboyPlugin and sets it as an alias on Airbridge, then starts tracking.

```TypeScript
AppboyPlugin.getDeviceId(function (brazeID) {
    Airbridge.state.setDeviceAlias("braze_device_id", brazeID)
  Airbridge.state.startTracking()
})
```

--------------------------------

### GET /preference_center/v1/{preferenceCenterExternalID}

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/preference_center/get_view_details_preference_center.md

This code snippet documents the GET endpoint for viewing details of a preference center, including path parameters, request example, and response schema.

```APIDOC
## GET /preference_center/v1/{preferenceCenterExternalID}

### Description
Use this endpoint to view the details for your preference centers, including when it was created and updated.

### Method
GET

### Endpoint
`/preference_center/v1/{preferenceCenterExternalID}`

### Parameters
#### Path Parameters
- **preferenceCenterExternalID** (String) - Required - The ID for your preference center.

#### Request Parameters
There are no request parameters for this endpoint.

### Request Example
```
curl --location -g --request GET https://rest.iad-01.braze.com/preference_center/v1/preference_center_external_id \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
```

### Response
#### Success Response (200)
- **name** (String) - The name of the preference center.
- **preference_center_api_id** (String) - The API ID of the preference center.
- **created_at** (String) - The time the preference center was created.
- **updated_at** (String) - The time the preference center was updated.
- **preference_center_title** (String) - The title of the preference center.
- **preference_center_page_html** (String) - The HTML for the preference center page.
- **confirmation_page_html** (String) - The HTML for the confirmation page.
- **redirect_page_html** (String) - The HTML for the redirect page (can be null).
- **preference_center_options** (Object) - Options for the preference center, such as meta-viewport-content.
- **state** (String) - The state of the preference center (e.g., active).

#### Response Example
```json
{
  "name": "My Preference Center",
  "preference_center_api_id": "preference_center_api_id",
  "created_at": "example_time_created",
  "updated_at": "example_time_updated",
  "preference_center_title": "Example preference center title",
  "preference_center_page_html": "HTML for preference center here",
  "confirmation_page_html": "HTML for confirmation page here",
  "redirect_page_html": null,
  "preference_center_options": {
    "meta-viewport-content": "width=device-width, initial-scale=2"
  },
  "state": "active"
}
```
```

--------------------------------

### Install iOS pods and run

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/sdk_repository_guides/react_native.md

Commands to install CocoaPods dependencies and run the app on iOS.

```bash
cd ios && pod install && cd ..
npx react-native run-ios
```

--------------------------------

### platform front matter example

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/yaml_front_matter/metadata.md

Sets related platforms as a list of Braze SDKs.

```markdown
---
platform:
  - iOS
  - Web
  - Android
---
```

--------------------------------

### GET /subscription/user/status - Example Response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/subscription_groups/get_list_user_subscription_groups.md

Example response showing subscription groups with status updates. Only groups with a history of status changes are included; newly created groups are not listed.

```json
{
    "users": [
        {
            "email": "test@example.com",
            "phone": "+11112223333",
            "external_id": "external_identifier",
            "subscription_groups": [
                {
                  "id": "ec2fcc919fca",
                  "name": "ActivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "7d7af9dd5556",
                  "name": "ReactivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "a5e84fd16220",
                  "name": "MarketingGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "64d8cad9176c",
                  "name": "TransactionalGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "b2134cd63942",
                  "name": "BankerMarketingGroup",
                  "channel": "sms",
                  "status": "Subscribed"
                }
            ]
        }
    ],
    "total_count": 1,
    "message": "success"
}
```

--------------------------------

### Build and serve Japanese locale

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/locale_preview_testing.md

Builds the Japanese locale and starts the preview server. Run this block, open the preview URLs, run the verification checklists, then stop the server before continuing to the next locale.

```bash
bundle exec rake "lang:build_fast[ja]"
rake ja
```

--------------------------------

### Open the braze-docs directory

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/your_first_contribution.md

Navigate to the braze-docs repository clone in the terminal.

```bash
cd ~/PATH_TO_REPOSITORY
```

--------------------------------

### Example of nav_expand_list with a relative path

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management/sections.md

Example of a completed nav_expand_list with a relative path for a section. The list includes the developer guide platforms path and the contributing content management path.

```yaml
# List of pages(path) to auto expand
nav_expand_list:
  - "/developer_guide/platforms"
  - "/contributing/content_management/"
```

--------------------------------

### Install CocoaPods

Source: https://github.com/braze-inc/braze-docs/blob/develop/_includes/developer_guide/swift/sdk_integration.md

Run this command to install CocoaPods, a dependency manager for Swift and Objective-C projects, as part of the Braze Swift SDK installation.

```bash
$ sudo gem install cocoapods
```

--------------------------------

### quick_reply_response_message example

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/objects_filters/messaging/whats_app_object.md

Example of a quick reply response message with two buttons.

```json
{
  "body": "Want to keep hearing from us?",
  "buttons": [
    {
      "text": "Yes!"
    },
    {
      "text": "No thanks"
    }
  ]
}
```

--------------------------------

### Build and serve Spanish locale

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/locale_preview_testing.md

Builds the Spanish locale and starts the preview server. Run this block, open the preview URLs, run the verification checklists, then stop the server before continuing to the next locale.

```bash
bundle exec rake "lang:build_fast[es]"
rake es
```

--------------------------------

### Liquid example referencing catalog item fields

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_user_guide/data/activation/catalogs/use.md

Example using the catalog_items tag with the item id 1234 and accessing title and price fields. Renders as 'Get Tales for just 7.49!'.

```liquid
{% catalog_items Games 1234 %}
 
Get {{ items[0].title }} for just {{ items[0].price }}!
```

--------------------------------

### GET /content_blocks/list - Example Request

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks.md

Example request to list available Content Blocks. Requires an API key with the `content_blocks.list` permission. The `modified_after`, `modified_before`, `limit`, and `offset` parameters are optional.

```curl
curl --location --request GET 'https://rest.iad-01.braze.com/content_blocks/list?modified_after=2020-01-01T01:01:01.000000&modified_before=2020-02-01T01:01:01.000000&limit=100&offset=1' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE'
```

--------------------------------

### Example output of committing changes

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/git_and_github.md

Example output when committing a change with a message.

```bash
$ git commit -m "Fixing a typo in the recommended software doc
[fixing-typo-in-recommended-software 8b05e34] Fixing a typo in the metadata doc.
 1 file changed, 1 insertion(+), 1 deletion(-)
```

--------------------------------

### Example collection configuration for partners

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/content_management/jekyll_collections.md

Shows a completed example of the collection configuration for 'partners' with title 'Technology Partners' and default nav URL 'home/'.

```yaml
collections:
  partners:
    title: Technology Partners
    output: true
    default_nav_url: home/

```

--------------------------------

### Start local Braze Docs server (English)

Source: https://github.com/braze-inc/braze-docs/blob/develop/docs/contributing/local_environment.md

Runs the default rake task to start the local docs server for the 'en' language on http://127.0.0.1:4000.

```bash
rake
```

--------------------------------

### Example success response for Get data object

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/data_objects/objects/get_data_object.md

Example success response body returned with status code `200`. It includes the data object record with type, identifier, and attributes.

```json
{
  "data_object": {
    "type_name": "account",
    "object_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}
```

--------------------------------

### Swift AppDelegate.swift Braze initialization

Source: https://github.com/braze-inc/braze-docs/blob/develop/_includes/developer_guide/react_native/sdk_integration.md

Example AppDelegate.swift setup for initializing Braze in a React Native app using the Swift implementation. Assumes an RCTAppDelegate-based setup; adjust if your app uses a different setup. Replace the API key and endpoint placeholders with your app's values.

```swift
func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
) -> Bool {
    // Setup Braze
    let configuration = Braze.Configuration(
        apiKey: "{BRAZE_API_KEY}",
        endpoint: "{BRAZE_ENDPOINT}")
    // Enable logging and customize the configuration here.
    configuration.logger.level = .info
    let braze = BrazeReactBridge.perform(
      #selector(BrazeReactBridge.initBraze(_:)),
      with: configuration
    ).takeUnretainedValue() as! Braze

    AppDelegate.braze = braze

    /* Other configuration */

    return true
}

// MARK: - AppDelegate.braze

static var braze: Braze? = nil
```

--------------------------------

### Example output URL

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_partners/message_personalization/dynamic_content/visual_and_interactive_content/cloudinary.md

Shows the resulting URL after the l_text transformation is applied with the user's name 'John Smith'. This output URL demonstrates the final asset with the text overlay.

```bash
<img src="https://res.cloudinary.com/demo/image/upload/l_text:Arial_300:%20John%20Smith%20,co_white,b_rgb:00000080/fl_layer_apply,g_north_west,y_200/docs/white-church-europe-sea.jpg">
```

--------------------------------

### SampleApp.swift - SwiftUI App Entry Point

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/in_app_messages/tutorials/conditionally_displaying_messages.md

Defines the main SwiftUI app structure, using the AppDelegate as an app delegate adaptor to integrate the Braze SDK setup.

```swift
import SwiftUI

@main
struct SampleApp: App {
  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

  var body: some Scene {
    WindowGroup {
      YourView()
    }
  }
}
```

--------------------------------

### Starts Session conversion behavior response

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_api/endpoints/export/campaigns/get_campaign_details.md

Example JSON response for a 'Starts Session' conversion event behavior, including the conversion window and app IDs array, or null if tracking sessions for any app.

```json
{
    "type": "Starts Session",
    "window": (integer) the number of seconds during which the user can convert on this event, such as 86400, which is 24 hours,
    "app_ids": (array or null) array of app ids, such as ["12345", "67890"], or `null` if "Track sessions for any app" is selected in the UI
}
```

--------------------------------

### Build and install Droidboy sample app

Source: https://github.com/braze-inc/braze-docs/blob/develop/_docs/_developer_guide/references.md

Commands to build and install the Droidboy sample app from the Android SDK directory. Use gradlew.bat on Windows for the assemble command.

```bash
./gradlew assemble
```

```bash
./gradlew installDebug
```
Tokens:
Raw