This page is also inEN
iTeam
API guide · Marketing and ads With your company’s credentials

Braze API: users, messages and campaigns with AI agents

The Braze REST API lets you update user profiles and events, trigger campaigns and messages, query segments and export data. CRM and growth teams use it to engage people by push, e-mail, SMS and other channels. Access is by a REST API key with permissions, on the company's instance URL.

Nina
API guide

What the Braze API offers

User data

Update attributes, events and purchases.

Messages

Send messages and trigger campaigns and journeys.

Segments

Query and export segments.

Catalogs

Manage catalogs used for personalization.

Export

Export user data and campaign metrics.

Subscriptions

Manage opt-in and subscription groups.

How to access the Braze API

  • With your company’s credentialsA REST API key created in the Braze dashboard with permissions per resource, sent in the header and used on the company's instance URL.
  • Use keys with minimal permissions.
  • Sends reach many users: require approval.
  • Respect consent and opt-out (GDPR and similar laws).

Official documentation: www.braze.com/docs/api/basics

What an iTeam agent does with the Braze API

Campaign summary

The agent brings deliveries, opens and conversions for the week's campaigns.

Send after support

After resolving a case, the agent triggers the follow-up journey.

Profile update

The agent records preferences the customer mentioned in support.

Campaign requests

The agent builds the campaign request and sends it only after approval.

From the credential to the agent at work, with approval

01

Create the REST key

In Braze, create a key with only the permissions needed.

02

Vault and rules

Store it in the iTeam vault and define which agents can trigger messages.

03

Test with an internal audience

Use a test segment and approval for sends.

Questions

Questions about the Braze API

Is the Braze API free?

There is no public API price; access is part of the contract with Braze.

Do I need to write code to use the Braze API with iTeam?

Not necessarily. iTeam's HTTP tool reads the API documentation and learns the endpoints, and the deployment team sets up credentials, permissions and tests with you.

Can the Braze API trigger campaigns?

Yes, there are endpoints to send messages and trigger configured campaigns and journeys, depending on the key's permissions.

Next step

Put an AI team to work this week.

Start free with a pre-built team, or talk to us and our squad puts AI in production with your people.

300+integrations
4languages
Agents working right now