Track user data including attributes, custom events, and purchases. Use this to update user profiles, log events, and record purchases in Braze.

Identify an alias-only user profile with an external_id. This merges the alias profile into the identified user.

Create new user aliases for existing users or create alias-only profiles.

Delete user profiles from Braze. This is permanent and cannot be undone. Use for GDPR/CCPA compliance.

Merge one user profile into another. Data from the merged user will be combined into the target user.

Update existing user aliases. Changes the alias_name for a given alias_label.

Rename external IDs for users. Use for migrating to a new ID scheme.

Remove deprecated external IDs that were previously renamed. Cleans up old ID references.

Send messages immediately to users via push, email, webhook, or content cards.

Trigger an API-triggered campaign. The campaign must be configured as API-triggered in Braze.

Trigger an API-triggered Canvas. The Canvas must be configured as API-triggered in Braze.

Send a transactional email via an API-triggered campaign. Used for order confirmations, password resets, etc.

Create a send ID for tracking message sends. Use to correlate sends with analytics.

Update an iOS Live Activity. Used for real-time updates like sports scores, delivery tracking.

List upcoming scheduled campaigns and Canvases.

Schedule a message to be sent at a specific time.

Update a previously scheduled message.

Delete a previously scheduled message.

Schedule an API-triggered campaign for future delivery.

Update a scheduled API-triggered campaign.

Delete a scheduled API-triggered campaign.

Schedule an API-triggered Canvas for future delivery.

Update a scheduled API-triggered Canvas.

Delete a scheduled API-triggered Canvas.

List all campaigns in the workspace.

Get details for a specific campaign.

Get campaign performance analytics over time.

Get analytics for a specific send ID.

List all Canvases in the workspace.

Get details for a specific Canvas.

Get Canvas performance analytics over time.

Get summary analytics for a Canvas.

List all segments in the workspace.

Get details for a specific segment.

Get segment size analytics over time.

Export user profiles by identifier (external_id, user_alias, or braze_id).

Export all user profiles in a segment (async job).

Export users in the Global Control Group.

Get daily active users (DAU) over time.

Get monthly active users (MAU) over time.

Get new users count over time.

Get app uninstalls over time.

List all custom events tracked in the app.

Get custom event analytics over time.

List all product IDs from purchase events.

Get purchase quantity analytics over time.

Get revenue analytics over time.

Get app session analytics over time.

Query emails that have hard bounced within a date range.

Query emails that have unsubscribed within a date range.

Change email subscription status for users.

Remove email addresses from the hard bounce list.

Remove email addresses from the spam list.

Add email addresses to the blocklist. Blocked emails will not receive any messages.

[DEPRECATED: Use email_blocklist] Add email addresses to the blacklist.

Query phone numbers that have been marked as invalid within a date range.

Remove phone numbers from the invalid phone list.

Get the subscription group status for users.

List all subscription groups for a specific user.

Update subscription group status for users (email or SMS/WhatsApp).

Update subscription group status for users (V2 API with more options).

List all email templates in the workspace.

Get details for a specific email template.

Create a new email template.

Update an existing email template.

List all content blocks in the workspace.

Get details for a specific content block.

Create a new content block.

Update an existing content block.

List all catalogs in the workspace.

Create a new catalog.

Delete a catalog and all its items.

List items in a catalog.

Create multiple items in a catalog.

Update multiple items in a catalog (replaces entire item).

Edit multiple items in a catalog (partial update).

Delete multiple items from a catalog.

Get a single catalog item by ID.

Create a single catalog item.

Update a single catalog item (replaces entire item).

Edit a single catalog item (partial update).

Delete a single catalog item.

List all preference centers in the workspace.

Get details for a specific preference center.

Generate a preference center URL for a specific user.

Create a new preference center.

Update an existing preference center.

Search for dashboard users by email address.

Create a new dashboard user account.

Get a dashboard user account by SCIM ID.

Update a dashboard user account.

Delete a dashboard user account. This is permanent.