API Identifier Types

This reference guide touches on the different types of API Identifiers that can be found within the Braze Dashboard, their purpose, where you can find them, and how they are typically used. For information on REST API Keys or App Group API Keys, click here.

The following API Identifiers can be used to access your template, canvas, campaign, segment, or card from Braze’s external API. All messages should follow UTF-8 encoding.

Template API Identifier

A Template API Identifier or Template ID is a key generated by Braze for a given template within the Dashboard. Template IDs are unique for each template and can be used to reference templates through the API.

Templates are great for if your company contracts out your HTML designs for campaigns. Once the templates have been built, you now have a template that is not specific to a campaign but can be applied to a series of campaigns like a newsletter.

Where can I find it?

You can find your Template ID one of two ways:

  1. In the Dashboard, open up “Templates & Media” under “Engagement” and select a pre-existing template. If the template you want does not exist yet, create one and save it. At the bottom of the individual template page, you will be able to find your Template API Identifier.

  2. Braze offers an “Additional API Identifiers” search, here you can quickly look up specific identifiers. It can be found at the bottom of the “API settings” within the “Developer Console” page.

What can it be used for?

  • Update templates over API
  • Grab information on a specific template


Canvas API Identifier

A Canvas API Identifier or Canvas ID is a key generated by Braze for a given canvas within the Dashboard. Canvas IDs are unique to each canvas and can be used to reference canvases through the API.

Note that if you have a Canvas that has variants, there exists an overall Canvas ID as well as individual variant Canvas IDs nested under the main Canvas.

Where can I find it?

You can find your Canvas ID one of two ways:

  1. In the Dashboard, open up “Canvas” under “Engagement” and select a pre-existing Canvas. If the Canvas you want does not exist yet, create one and save it. At the bottom of an individual Canvas page, you will find an “Analyze Variants” button, upon clicking it, a window will appear with the Canvas API Identifier located at the bottom.

  2. Braze offers an “Additional API Identifiers” search, here you can quickly look up specific identifiers. It can be found at the bottom of the “API settings” within the “Developer Console” page.

What can it be used for?

  • Track analytics on a specific message
  • Grab high-level aggregate stats on Canvas performance
  • Grab details on a specific Canvas
  • With currents to bring in user-level data for a “bigger picture” approach to canvases
  • With API trigger delivery in order to collect statistics for transactional messages


Campaign API Identifier

A Campaign API Identifier or Campaign ID is a key generated by Braze for a given campaign within the Dashboard. Campaign IDs are unique to each campaign and can be used to reference campaigns through the API.

Note that if you have a Campaign that has variants, there exists an overall Campaign ID as well as individual variant Campaign IDs nested under the main campaign.

Where can I find it?

You can find your Campaign ID one of two ways:

  1. In the Dashboard, open up “Campaigns” under “Engagement” and select a pre-existing Campaign. If the Campaign you want does not exist yet, create one and save it. At the bottom of the individual campaign page, you will be able to find your Campaign API Identifier.

  2. Braze offers an “Additional API Identifiers” search, here you can quickly look up specific identifiers. It can be found at the bottom of the “API settings” within the “Developer Console” page.

What can it be used for?

  • Track analytics on a specific message
  • Grab high-level aggregate stats on Campaign performance
  • Grab details on a specific Campaign
  • With currents to bring in user-level data for a “bigger picture” approach to campaigns
  • With API trigger delivery in order to collect statistics for transactional messages


Segment API Identifier

A Segment API Identifier or Segment ID is a key generated by Braze for a given Segment within the Dashboard. Segment IDs are unique to each segment and can be used to reference segments through the API.

Where can I find it?

You can find your Segment ID one of two ways:

  1. In the Dashboard, open up “Segments” under “Engagement” and select a pre-existing segment. If the Segment you want does not exist yet, create one and save it. At the bottom of the individual segment page, you will be able to find your Segment API Identifier.

  2. Braze offers an “Additional API Identifiers” search, here you can quickly look up specific identifiers. It can be found at the bottom of the “API settings” within the “Developer Console” page.

What can it be used for?

  • Get details on a specific segment
  • Retrieve analytics of a specific segment
  • Pull how many times a custom event was recorded for a particular segment
  • Specify and send a campaign to a members of a segment from within the API

Card API Identifier

A Card API Identifier or Card ID is a key generated by Braze for a given News Feed Card within the Dashboard. Card IDs are unique to each News Feed Card and can be used to reference Cards through the API.

Where can I find it?

You can find your Card ID one of two ways:

  1. In the Dashboard, open up “News Feed” under “Engagement” and select a pre-existing News Feed. If the News Feed you want does not exist yet, create one and save it. At the bottom of the individual News Feed page, you will be able to find your unique Card API Identifier.

  2. Braze offers an “Additional API Identifiers” search, here you can quickly look up specific identifiers. It can be found at the bottom of the “API settings” within the “Developer Console” page.

What can it be used for?

  • Retrieve relevant information on a card
  • Track events related to Content Cards and engagement


WAS THIS PAGE HELPFUL?
New Stuff!