Braze API Overview

Braze provides a high performance REST API to allow you to track users, send messages, export data, and more.

A REST API is a way to programmatically transfer information over the web using a predefined schema. Braze has created many different endpoints with specific requirements that will perform various actions and/or return various data. API access is done using HTTPS web requests to your company’s REST API endpoint (this will correspond to your Dashboard URL as shown in the table below).

Customers using Braze’s EU database should use https://rest.fra-01.braze.eu/. For more information on REST API endpoints for customers using Braze’s EU database see our EU/US Implementation Differences documentation.

Braze Instances

Using Braze’s Postman Collection

If you have a Postman account (MacOS, Windows, and Linux versions can be downloaded from their website located here), you can go to our Postman documentation and click the orange Run in Postman button in the top, right corner. This will allow you to create an environment, as well as edit the available POST and GET requests to suit your own needs.

Setting Up Your Postman Environment

The Braze Postman Collection uses a templating variable, {{instance_url}}, to substitute the REST API URL of your Braze instance into the pre-built requests. Rather than having to manually edit all requests in the Collection, you can set up this variable in your Postman environment. To do so, please follow the steps below:

1. Click on the gear icon in the top right corner of the Postman app.
2. Select “Manage Environments” to open a modal window which displays your active environments.
3. In the bottom right corner of the modal window, click “Add” to create a new environment.
4. Give this environment a name (e.g. “Braze API Requests”) and add keys for instance_url and api_key with values corresponding to your Braze instance and Braze REST API Key, as pictured below.

As of April, 2020 Braze has changed how we read App Group API keys. Instead of passing them in the request body or through url parameters, we now read the App Group Restapi_key through the HTTP Authorization header. API keys not passed through the HTTP Authorization Header will coninue to work until they have been sunset.

Using the Pre-Built Requests from the Collection

Once you have configured your environment. You can use any of the pre-built requests in the collection as a template for building new API requests. To start using one of the pre-built requests, simply click on it within the ‘Collections’ menu on the left side of Postman. This will open the request as a new tab in the main window of the Postman app.

In general, there are two types of requests that Braze’s API endpoints accept - GET and POST. Depending on which HTTP method the endpoint uses, you’ll need to edit the pre-built request differently.

Edit a POST Request

When editing a POST request, you’ll need to open the request and navigate to the Body section in the request editor. For readability, select the raw radio button to format the JSON request body.

Edit a GET Request

When editing a GET request, you will need to edit the parameters passed in the request URL. To edit these easily, select the Params button next to the URL bar and edit the key-value pairs in the fields that will appear below the URL bar.

Send Your Request

Once your API request is ready to send, click on the ‘Send’ button next to the URL bar. The request will be sent and the response data will be populated in a section underneath the request editor. From here, you can view the raw data returned from Braze’s API, see the HTTP response code, see how long the request took to process, and view header information.

Use this page to mock Braze Endpoints in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of Braze Endpoints, which will allow you to keep building and testing even if the actual API you isn't currently available.