# Braze integration

> Customer engagement platform API for user profiles and events, campaigns, Canvases, messaging, catalogs, templates, segments, and analytics exports.

- Authentication: apiKey

## Tools (144)

- **Blacklist emails**: Unsubscribe users from email and mark them hard bounced (legacy name of the blocklist endpoint).
- **Blocklist emails**: Unsubscribe users from email and mark them hard bounced.
- **Cancel exports by segment**: Cancel all ongoing user exports for a segment.
- **CDI: List integrations**: List existing Cloud Data Ingestion integrations (10 per page).
- **CDI: List job sync status**: List past sync statuses for a Cloud Data Ingestion integration (10 per page).
- **CDI: Trigger a sync**: Start an on-demand sync for a Cloud Data Ingestion integration.
- **Change email subscription status**: Set the global email subscription state for users by email address.
- **Create and update users**: Record custom events and purchases and update user profile attributes.
- **Create and update users (bulk)**: Record events, purchases and attribute updates in bulk (limited beta).
- **Create and update users (synchronous)**: Synchronously record one event, attribute or purchase update and return the resulting profile fields (limited beta).
- **Create catalog**: Create a catalog.
- **Create catalog fields**: Create multiple fields in a catalog.
- **Create catalog item**: Create a single item in a catalog.
- **Create catalog selection**: Create a selection (filtered subset) in a catalog.
- **Create Content Block**: Create a Content Block.
- **Create data object**: Create one data object for a type (Data Objects, early access).
- **Create email template**: Create an email template on the Braze dashboard.
- **Create multiple catalog items**: Create up to 50 items in a catalog (asynchronous).
- **Create new user alias**: Add aliases to existing users or create alias-only users.
- **Create object relationship**: Create one directional relationship edge between two data objects (Data Objects, early access).
- **Create preference center**: Create a preference center where users manage email notification preferences.
- **Create scheduled messages**: Schedule a message to send at a designated time; returns a schedule_id.
- **Create SDK Authentication key**: Create a new SDK Authentication key for an app (max 3 per app).
- **Create send IDs**: Create send IDs for tracking programmatic sends without a campaign per send.
- **Create user relationship**: Link one Braze user to one data object (Data Objects, early access).
- **Delete a catalog item**: Delete a single item from a catalog.
- **Delete catalog**: Delete a catalog.
- **Delete catalog field**: Delete a catalog field.
- **Delete catalog selection**: Delete a catalog selection.
- **Delete data object**: Delete one data object (Data Objects, early access).
- **Delete multiple catalog items**: Delete up to 50 items from a catalog (asynchronous).
- **Delete object relationship**: Delete one object-to-object relationship edge (Data Objects, early access).
- **Delete scheduled API-triggered campaigns**: Cancel a scheduled API-triggered campaign message before it is sent.
- **Delete scheduled API-triggered Canvases**: Cancel a scheduled API-triggered Canvas message before it is sent.
- **Delete scheduled messages**: Cancel a message scheduled with /messages/schedule/create before it is sent.
- **Delete SDK Authentication key**: Delete an SDK Authentication key for an app (the primary key cannot be deleted).
- **Delete user relationship**: Remove one user-to-object relationship (Data Objects, early access).
- **Delete users**: Permanently delete user profiles by identifier.
- **Duplicate campaigns using the API**: Duplicate a campaign (created asynchronously).
- **Duplicate Canvases using the API**: Duplicate a Canvas (created asynchronously).
- **Edit catalog item**: Edit a single existing catalog item.
- **Edit multiple catalog items**: Edit up to 50 existing items in a catalog (asynchronous).
- **Export app session by time**: Retrieve a series of session counts for your app over a period.
- **Export campaign analytics**: Retrieve a daily series of send, open, click and conversion stats for a campaign.
- **Export campaign details**: Retrieve details of one campaign: status, channels, messages and conversion behaviors.
- **Export campaigns list**: Export a list of campaigns with names, API identifiers, and tags (100 per page).
- **Export Canvas data series analytics**: Export time series stats for a Canvas, with optional variant and step breakdowns.
- **Export Canvas data summary analytics**: Export rolled-up summary stats for a Canvas over a period.
- **Export Canvas details**: Retrieve details of one Canvas: status, variants, steps and messages.
- **Export Canvas list**: Export a list of Canvases with names, API identifiers, and tags (100 per page).
- **Export custom attributes**: Export the custom attributes recorded for your app, 50 per page.
- **Export custom events**: Export custom events with descriptions and status, 50 per page.
- **Export custom events analytics**: Retrieve a time series of occurrences of a custom event.
- **Export custom events list**: Export the names of custom events recorded for your app, 250 per page.
- **Export daily active users by date**: Retrieve a daily series of unique active users.
- **Export daily new users by date**: Retrieve a daily series of new user counts.
- **Export KPIs for daily app uninstalls by date**: Retrieve a daily series of app uninstall counts.
- **Export monthly active users for last 30 days**: Retrieve a daily series of unique active users over a 30-day rolling window.
- **Export number of purchases**: Return the total number of purchases over a time range.
- **Export product IDs**: Return a paginated list of purchase product IDs.
- **Export revenue data by time**: Return total money spent in your app over a time range.
- **Export segment analytics**: Retrieve a daily series of the estimated size of a segment.
- **Export segment details**: Retrieve details of one segment.
- **Export segment list**: Export a list of segments with API identifiers, names, and tags (100 per page).
- **Export send analytics**: Retrieve a daily series of stats for a tracked send_id of an API campaign.
- **Export user profile by Global Control Group**: Export all users in the Global Control Group as files (read-only export request).
- **Export user profile by identifier**: Export full user profiles for specified identifiers (read-only; POST body).
- **Export user profile by segment**: Export all users in a segment as files (read-only export request).
- **Generate preference center URL**: Generate a unique preference center URL for a user.
- **Get data object**: Return one data object (Data Objects, early access).
- **Get data object type**: Return one data object type and its schema definition (Data Objects, early access).
- **Identify users**: Merge an alias-only, email-only or phone-only profile into an identified profile.
- **List available Content Blocks**: List existing Content Blocks.
- **List available email templates**: List email templates (drag-and-drop templates excluded).
- **List catalog item details**: Return a single catalog item and its content.
- **List catalogs**: Return the list of catalogs in the workspace.
- **List data objects**: List objects of a data object type (Data Objects, early access).
- **List data object types**: List data object types in the workspace (Data Objects, early access).
- **List multiple catalog item details**: Return up to 50 catalog items per page with their content.
- **List object relationships**: List related data objects from one object anchor (Data Objects, early access).
- **List object relationship types**: List relationship kinds available for object-to-object links of a type (Data Objects, early access).
- **List preference centers**: List the available preference centers.
- **List SDK Authentication keys**: Retrieve all SDK Authentication keys for an app.
- **List upcoming scheduled campaigns and Canvases**: List scheduled campaigns and entry Canvases between now and an end time.
- **List user relationships**: List users linked to one data object (Data Objects, early access).
- **List user relationship types**: List valid rel_kind values for user relationships on a data object type (Data Objects, early access).
- **List user’s subscription groups**: List the subscription groups (with history) of specific users.
- **List user’s subscription group status**: Get a user's subscription state in a specific subscription group.
- **Merge users**: Merge one user profile into another (asynchronous, up to 50 merges).
- **Query hard bounced emails**: List email addresses that hard bounced in a date range, or check one email.
- **Query invalid phone numbers**: List phone numbers marked invalid in a date range, or check specific numbers.
- **Query list of unsubscribed email addresses**: List emails that unsubscribed in a date range, or check one email.
- **Remove email addresses from spam list**: Remove email addresses from the Braze spam list and the email provider's spam list.
- **Remove external ID**: Permanently remove users' deprecated external IDs.
- **Remove hard bounced emails**: Remove email addresses from the Braze bounce list and the email provider's bounce list.
- **Remove invalid phone numbers**: Remove phone numbers from the invalid list to re-validate them.
- **Rename external ID**: Set new primary external IDs for users and deprecate the old ones.
- **Replace an asset in the media library**: Replace the file of an existing media library asset while keeping its asset ID and URL.
- **Replace catalog item**: Replace a single catalog item, creating it if the item_id is not found.
- **Replace catalog items**: Replace up to 50 items in a catalog, creating any that do not exist (asynchronous).
- **Replace data object**: Create or fully replace a data object (Data Objects, early access).
- **Replace object relationship**: Create or replace an object relationship (Data Objects, early access).
- **Replace user relationship**: Create or replace one user relationship (Data Objects, early access).
- **Schedule API-triggered campaigns**: Schedule an API-triggered campaign send with optional trigger properties.
- **Schedule API-triggered Canvases**: Schedule an API-triggered Canvas entry with optional context.
- **See Content Block information**: Get the content and metadata of one Content Block.
- **See email template information**: Get the details of one email template.
- **Send campaign messages using API-triggered delivery**: Send an API-triggered campaign immediately to recipients, an audience, or the campaign segment.
- **Send Canvas messages using API-triggered delivery**: Send an API-triggered Canvas immediately to recipients, an audience, or the Canvas segment.
- **Send messages immediately using the API only**: Send immediate messages to designated users or a segment via the API.
- **Send transactional emails using API-triggered delivery**: Send an immediate one-off transactional email to a single user via a Transactional Email campaign.
- **Set primary SDK Authentication key**: Set an SDK Authentication key as the primary key for an app.
- **Start Live Activity**: Remotely start an iOS Live Activity for a segment, connected audience, or specific users.
- **Update Content Block**: Update an existing Content Block.
- **Update data object**: Merge attributes into an existing data object (Data Objects, early access).
- **Update existing email templates**: Update an email template; at least one field besides the ID is required.
- **Update Live Activity**: Update or end an iOS Live Activity.
- **Update object relationship**: Merge attributes onto an existing object relationship (Data Objects, early access).
- **Update preference center**: Update an existing preference center.
- **Update push credentials**: Update the push credentials for a single app and one push platform.
- **Update scheduled API-triggered campaigns**: Replace the schedule of a scheduled API-triggered campaign.
- **Update scheduled API-triggered Canvases**: Replace the schedule of a scheduled API-triggered Canvas.
- **Update scheduled messages**: Update the schedule or messages of a scheduled message.
- **Update translation in a campaign**: Update multiple translations for a campaign message variation and locale.
- **Update translation in a Canvas**: Update multiple translations for a Canvas step message and locale.
- **Update translation in a Content Block**: Update multiple translations for a Content Block and locale.
- **Update translations for an email template**: Update the translations of an email template for a locale.
- **Update translations for a webhook template**: Update the translations of a webhook template for a locale.
- **Update user alias**: Rename existing user aliases.
- **Update user relationship**: Merge attributes into an existing user relationship (Data Objects, early access).
- **Update user’s subscription group status**: Batch update the subscription state of up to 50 users in one subscription group.
- **Update user’s subscription group status (V2)**: Batch update subscription states across multiple subscription groups in one request.
- **Upload an asset to the media library**: Add an image, document or ZIP to the Braze media library from a URL or binary data.
- **View all translations and locales for an email template**: View all translations and locales for an email template.
- **View all translations for a campaign**: View all translations for each message variant in a campaign.
- **View all translations for a Content Block**: View all translations for a Content Block.
- **View a specific translation and locale for email template endpoint**: View the translation for a specific locale of an email template.
- **View default source values for a campaign’s translation tags**: View the default source strings inside a campaign's translation tags.
- **View default source values for a canvas’s translation tags**: View the default source strings inside a Canvas step's translation tags.
- **View default source values for a Content Block’s translation tags**: View the default source strings inside a Content Block's translation tags.
- **View details for preference center**: View the details of one preference center, including HTML and timestamps.
- **View the source translations for an email template**: View the source translation strings of an email template.
- **View translation for a Canvas**: Preview translations for a Canvas step message.
- **View translations for a webhook template**: View translations of a webhook template, optionally for one locale.

Connect Braze in General Input: https://www.generalinput.com/apps/braze