Sample API Requests
Braze allows you to generate sample API requests for all of our endpoints via our Postman Collection.
What is Postman?
Postman is a free-to-use visual editing tool for building and testing API requests. As opposed to other methods for interacting with APIs (e.g. using cURL), Postman allows you to easily edit API requests, view header information, and much more. Postman has the ability for you to save Collections or libraries of sample premade API requests. To make it easy for our customers to get up and running with our REST API, we created a Collection with premade examples for all of our API endpoints.
Postman has MacOS, Windows and Linux versions can be downloaded from their website located here.
Getting the Braze Postman Collection
The Braze Postman Collection can be added to your local Postman app by doing the following:
- Open the app and click the the “Import” button in the upper left corner.
- Within the modal window that opens, select the “Import from Link” option
- Copy and paste this URL
https://www.getpostman.com/collections/94d02cde897232440df7and click “Import”.
Setting up your Postman Environment
The Braze Postman Collection uses a templating variable, ``, 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:
- Click on the gear icon in the top right corner of the Postman app:
- Select “Manage Environments” to open a modal window which displays your active environments.
- In the bottom right corner of the modal window, click “Add” to create a new environment.
- Give this environment a name (e.g. “Braze API Requests”) and add keys for
api_keywith values corresponding to your Braze REST API URL and Braze REST API Key as pictured below. Please note The
api_keyshould be encapsulated in quotes.
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 -
POST. Depending on which HTTP method the endpoint uses, you’ll need to edit the pre-built request differently.
Editing 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.
Editing 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.
Sending your request and viewing the response data
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.