How to Create a Braze API Key

Overview

Follow this guide to learn how to locate and create a new Braze API Key.


How to Create a Braze API Key

Access API Keys Settings:

  • Begin on the Braze homepage and use the left-hand navigation menu to click on the "Settings" tab.
  • An additional menu will appear, locate and click on the "API and Identifier" tab.
    • Note: If you are using the older navigation version, first access the developer console and then navigate to the API Settings page.

Create API Key:

  • Once on the API and Identifier Settings page, click on the "Create API Key" button located in the upper right-hand corner of the page.

Customize API Key:

  • Use the text box to enter an identifiable name for your new API key.
  • Select the "users.track" permission to be associated with your new key.
    • Note: Once you generate a new API key, you cannot edit or change the scope of permissions. If you need to make changes, it's recommended to generate and implement a new API key.

📘

Learn More: API Key Permissions

Read this article to learn more about Rest API key permissions.