Skip to content

API Settings tab

The API Settings tab displays API identifications for your app group. The first section on Services lists relevant articles for different uses of the Braze API (User Data,Messaging, Email Sync, or Export).

The API Settings page is further divided into the following sections:

  • REST API Keys
  • Identification
  • Additional API Identifiers

REST API keys

This section provides your App Group REST API keys, the unique identifiers that allow you access to your data for an app group. A REST API key is required with every request to the Braze API. For more information on creating and using API keys, refer to our REST API key overview.

API IP allowlisting

For additional security, you can specify a list of IP addresses and subnets which are allowed to make REST API requests for a given REST API Key. This is referred to as allowlisting, or whitelisting. To allow specific IP addresses or subnets, add them to the Whitelist IPs section when creating a new REST API Key:

API IP Whitelisting section of creating a new API key

If you don’t specify any, requests can be sent from any IP address.

Identification

The Identification section includes a list of identifiers that are used to reference specific apps in requests made to the Braze API. To learn more about application identifiers, refer to App Identifier API key.

Additional API identifiers

To integrate with our API, you can search for the identifiers related to any segments, campaigns, cards and more that you want to access from Braze’s external API. All messages should follow UTF-8 encoding. Once you’ve selected any of them, the identifier will be displayed underneath the dropdown menu. .

For more information, refer to API Identifier Types.

WAS THIS PAGE HELPFUL?
New Stuff!