Braze

Record custom events, purchases, and user attributes (POST /users/track). Accepts attributes[], events[], and purchases[] arrays in a single call.

Export user profiles by external_id, user_alias, braze_id, email, or phone (POST /users/export/ids).

Trigger an asynchronous export of all users in a segment to a connected storage bucket (POST /users/export/segment).

Delete user profiles by external_id, user_alias, or braze_id (POST /users/delete). This action is irreversible.

Add new user aliases for existing users or create new alias-only profiles (POST /users/alias/new).

Update the alias label or name of existing user aliases (POST /users/alias/update).

Merge an anonymous, alias-only user into an identified user by external_id (POST /users/identify).

Merge up to 50 pairs of users, transferring specified data from a source profile to a target profile (POST /users/merge).

Rename existing external IDs, moving profiles to new external IDs (POST /users/external_ids/rename).

Remove deprecated external IDs after a rename migration (POST /users/external_ids/remove).

List Canvases, most-recently-updated first (GET /canvas/list). Page-based pagination via the 0-indexed 'page' parameter (100 per page).

Get details for a single Canvas (GET /canvas/details), including steps, channels, and variations.

Get a daily series of engagement stats for a Canvas over a time window (GET /canvas/data_series).

Get rollup engagement stats for a Canvas over a time window (GET /canvas/data_summary).

Send an API-triggered Canvas immediately to designated users (POST /canvas/trigger/send).

Schedule an API-triggered Canvas for future delivery (POST /canvas/trigger/schedule/create).

Update a scheduled API-triggered Canvas by schedule_id (POST /canvas/trigger/schedule/update).

Cancel a scheduled API-triggered Canvas by schedule_id (POST /canvas/trigger/schedule/delete).

List all catalogs in the workspace (GET /catalogs).

Create a catalog with a defined field schema (POST /catalogs).

Delete a catalog by name (DELETE /catalogs/{catalog_name}).

List multiple catalog items, paginated (GET /catalogs/{catalog_name}/items).

Get a single catalog item by id (GET /catalogs/{catalog_name}/items/{item_id}).

Create multiple items in a catalog (POST /catalogs/{catalog_name}/items).

Create or update multiple items in a catalog (PUT /catalogs/{catalog_name}/items).

Delete multiple items from a catalog (DELETE /catalogs/{catalog_name}/items).

List campaigns, most-recently-updated first (GET /campaigns/list). Page-based pagination via the 0-indexed 'page' parameter (10 per page). Identity + connectivity probe.

Get details for a single campaign (GET /campaigns/details), including message variations, conversion behaviors, and channels.

Get a daily series of engagement stats for a campaign over a time window (GET /campaigns/data_series).

Send an API-triggered campaign immediately to designated users (POST /campaigns/trigger/send).

Schedule an API-triggered campaign for future delivery (POST /campaigns/trigger/schedule/create).

Update a scheduled API-triggered campaign by schedule_id (POST /campaigns/trigger/schedule/update).

Cancel a scheduled API-triggered campaign by schedule_id (POST /campaigns/trigger/schedule/delete).

Query a list of email addresses that unsubscribed within a time window (GET /email/unsubscribes).

Query a list of email addresses that hard bounced within a time window (GET /email/hard_bounces).

Set the email subscription state (subscribed/unsubscribed/opted_in) for one or more addresses (POST /email/status).

Remove email addresses from the Braze hard bounce list (POST /email/bounce/remove).

Remove email addresses from the Braze spam list (POST /email/spam/remove).

Unsubscribe and hard-suppress email addresses from all future sends (POST /email/blocklist).

Send immediate messages to designated users via API-triggered delivery (POST /messages/send).

Schedule immediate or future messages for delivery (POST /messages/schedule/create).

Update a previously scheduled message by schedule_id (POST /messages/schedule/update).

Cancel a previously scheduled message by schedule_id (POST /messages/schedule/delete).

Update an iOS Live Activity's content or state via API (POST /messages/live_activity/update).

List available email Content Blocks (GET /content_blocks/list). Offset pagination.

Get information about a specific email Content Block (GET /content_blocks/info).

Create an email Content Block (POST /content_blocks/create).

Update an existing email Content Block (POST /content_blocks/update).

Get a daily series of the total number of new users on each date (GET /kpi/new_users/data_series).

Get a daily series of the total unique active users over a rolling 30-day period (GET /kpi/mau/data_series).

Get a daily series of the total number of unique active users on each date (GET /kpi/dau/data_series).

Get a daily series of the total number of uninstalls on each date (GET /kpi/uninstalls/data_series).

List available email templates, most-recently-updated first (GET /templates/email/list). Offset pagination.

Get information about a specific email template (GET /templates/email/info).

Create an email template in the Braze dashboard (POST /templates/email/create).

Update an existing email template (POST /templates/email/update).

List segments, most-recently-updated first (GET /segments/list). Page-based pagination via the 0-indexed 'page' parameter (100 per page).

Get details for a single segment (GET /segments/details), including analytics tracking status and creation info.

Get a daily series of the estimated size of a segment over a time window (GET /segments/data_series).

Set the subscription state of users in a subscription group by email or phone (POST /subscription/status/set).

Get the subscription state of a user for a specific subscription group (GET /subscription/status/get).

List all subscription groups and states for a given user (GET /subscription/user/status).

Get a daily series of engagement stats for a tracked send_id within a campaign (GET /sends/data_series).

Create a send identifier for tracking message performance programmatically (POST /sends/id/create).

Trigger a manual sync for a Cloud Data Ingestion integration (POST /cdi/{integration_id}/sync).

Get a daily series of the number of sessions over a time window (GET /sessions/data_series).

Send a transactional email campaign message to a single user (POST /transactional/v1/campaigns/{campaign_id}/send).

Batch-update the subscription state of up to 50 users across subscription groups (POST /v2/subscription/status/set).