--- title: Braze modules slug: braze-modules image: https://make-cxp-documentation.ams3.cdn.digitaloceanspaces.com/apps-center-icons/PREVIEW_DEFAULT.png docTags: createdAt: 2025-03-10T15:49:04.067Z --- After connecting to the Braze app, you can use the following modules to build your scenarios. # Users :::ExpandableHeading ## Create or update a user profile Creates or updates attributes, events or purchases for a user profile given its Braze ID, external ID or user alias. | **Field** | **Description** | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Action** | Select the action that you want to perform in this module. | | **Update Existing Profiles Only** | Select whether you want to update profiles or create new ones. | | **Braze ID** | Enter a user ID in your Braze account.
If you have a use ID in your Braze account, you may not specify a user external ID, user alias, email, or phone number. | | **External ID** | Enter an external user ID.
If you have an external user ID, you may not specify a user Braze ID, user alias, email, or phone number. | | **User Alias** | Enter a user alias label and name.
If you have a user alias, you may not specify a user Braze ID, user external ID, email, or phone number. | | **Email** | Enter a user's email.
If you have a user's email, you may not specify a user Braze ID, user external ID, user alias, or phone number. | | **Phone** | Enter a user's phone number.
If you have a user's phone number, you may not specify a user Braze ID, user external ID, user alias, or email. | | **User attributes** | Enter desired values to the user attributes fields. | | **Custom Attributes View** | Select the attributes view to define custom attributes. The **Simplified View** shows all the attributes as they are in your Braze account. The **Advanced View** uses a JSON string. | | **Custom attributes** | Enter desired values to the custom attributes fields. Displayed fields are automatically loaded from your Braze account. | | **Event attributes** | Enter desired values to the event attributes fields. | | **Purchase attributes** | Enter desired values to the purchase attributes fields. | ::: :::ExpandableHeading ## List catalogs Gets a list of all catalogs. | F**ield** | **Description** | | -------------- | ------------------------------------------------------------------------------ | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Limit** | Set the Maximum number of results Make will return during one execution cycle. | ::: :::ExpandableHeading ## Create a catalog Creates a new catalog. | **Field** | **Description** | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Catalog Name** | Enter the name for a new catalog. | | **Catalog Description** | Enter the description for a new catalog. | | **Item Fields** | Enter or map the following information:
* **Name:** Enter the name for an item. * **Type:** Select or map the type of an item. | ::: :::ExpandableHeading ## Delete a catalog Deletes a catalog given its name. | **Field** | **Description** | | ---------------- | ------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Catalog Name** | Enter or map the name of the catalog that you want to delete. | ::: # Catalog items :::ExpandableHeading ## List catalog items Gets a list of items inside a given catalog. | **Field** | **Description** | | ---------------- | ---------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Catalog Name** | Enter or map the name of the catalog which items you want to list. | | **Limit** | Set the Maximum number of teams Make will return during one execution cycle. | ::: :::ExpandableHeading ## Get a catalog item Gets a catalog item given its ID. | **Field** | **Description** | | ---------------- | ------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Catalog Name** | Enter or map the name of the catalog which item you want to get. | | **Item ID** | Enter or map the ID of the item that you want to get. | ::: :::ExpandableHeading ## Create or update a catalog item Creates or updates a catalog item given its ID. | **Field** | **Description** | | ---------------- | ----------------------------------------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Action** | Select the action that you want to perform in this module. | | **Catalog Name** | Enter or map the name of the catalog where you want to create or update an item. | | **Item ID** | Enter the name for a new catalog or a catalog that you want to update. | | **Item details** | Enter desired values to the item fields. Displayed fields are automatically loaded from your Braze account. | ::: :::ExpandableHeading ## Delete a catalog item Deletes a catalog item given its ID. | **Field** | **Description** | | ---------------- | ------------------------------------------------------------------------- | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Catalog Name** | Enter or map the name of the catalog which item you want to delete. | | **Item ID** | Enter or map the name of the item that you want to delete.
| ::: # Messages :::ExpandableHeading ## Send a campaign message Sends a message from a given campaign. | **Field** | **Description** | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Connection** | [Create a connection to your Braze account](docId:4s1tky14WTPoRtvSKR5mP). | | **Campaign ID** | Enter the ID of the campaign from which you want to send a message. | | **Send ID** | Enter the send ID. | | **Broadcast** | Select if you want to send a message to an entire segment that a canvas targets.
If broadcast is set to `true`, you cannot include a recipients list. | | **Recipients** | Enter the following information:
* **External User ID:** Enter an external user ID. If you have an external user ID, you may not specify a user alias or email. * **User Alias**: Enter a user alias label and name. If you have a user alias, you may not specify an external user ID or email. * **Email**: Enter a user email. If you have a user email, you may not specify an external user ID or user alias. * **Prioritization**: Select or map an option for prioritizing the most recently updated user. Refer to Braze API documentation to learn more. * **Canvas Properties Entries View**: Select or map the canvas properties entries view to define canvas entry properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string. Refer to Braze API documentation to learn more. * **Canvas Entry Properties**: Enter a key and value for each canvas entry property. Refer to Braze API documentation to learn more. * **Send to existing only**: Select or map whether you want to send a message to existing recipients only. If you set it as no, you cannot use a user alias, and you must use custom attributes. * **Custom Attributes View**: Select or map the attributes view to define custom attributes. The Simplified View shows all the attributes as they are in your Braze account. The Advanced View uses a JSON string. * **Custom Attributes**: Enter desired values of the custom attributes fields. Displayed fields are automatically loaded from your Braze account. | | **Audience Select View** | Select the audience select view to customize messages. The **Simplified View** allows setting up a filter with the `and` and `or` rules. The **Advanced View** uses a JSON string. | | **Audience** | Set up a filter for audiences using operators. | | **Trigger Properties View** | Select the trigger properties view to define canvas entry properties. The **Simplified View** allows setting up a filter with the `and` and `or` rules. The **Advanced View** uses a JSON string. | | **Trigger Properties** | Enter a key and value for each trigger property. | | **Attachments** | Enter the following information:
* **File Name: **Enter a name for the file. For example, image.jpg * **URL:** Enter the URL of the file you want to attach to your message. | ::: :::ExpandableHeading ## Send a canvas message Sends a message from a given canvas. | **Field** | **Description** | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Connection** | [Establish a connection to your Braze account](#). | | **Canvas ID** | Enter the ID of the canvas from which you want to send a message. | | **Broadcast** | Select if you want to send a message to an entire segment that a canvas targets.
If broadcast is set to `true`, you cannot include a recipients list. | | **Recipients** | Enter the following information:
* **External User ID:** Enter an external user ID. If you have an external user ID, you may not specify a user alias or email. * **User Alias**: Enter a user alias label and name. If you have a user alias, you may not specify an external user ID or email. * **Email**: Enter a user email. If you have a user email, you may not specify an external user ID or user alias. * **Prioritization**: Select or map an option for prioritizing the most recently updated user. Refer to Braze API documentation to learn more. * **Canvas Properties Entries View**: Select or map the canvas properties entries view to define canvas entry properties. The Simplified View allows setting up trigger properties one by one. The Advanced View uses a JSON string. Refer to Braze API documentation to learn more. * **Canvas Entry Properties**: Enter a key and value for each canvas entry property. Refer to Braze API documentation to learn more. * **Send to existing only**: Select or map whether you want to send a message to existing recipients only. If you set it as no, you cannot use a user alias, and you must use custom attributes. * **Custom Attributes View**: Select or map the attributes view to define custom attributes. The Simplified View shows all the attributes as they are in your Braze account. The Advanced View uses a JSON string. * **Custom Attributes**: Enter desired values of the custom attributes fields. Displayed fields are automatically loaded from your Braze account. | | **Audience Select View** | Select the audience select view to customize messages. The **Simplified View** allows setting up a filter with the `and` and `or` rules. The **Advanced View** uses a JSON string. | | **Audience** | Set up a filter for audiences using operators. | | **Canvas Entry Properties View** | Select the canvas properties entries view to define canvas entry properties. The **Simplified View** allows setting up a filter with the `and` and `or` rules. The **Advanced View** uses a JSON string. | | **Canvas Entry Properties** | Enter a key and value for each canvas entry property. | ::: # Other :::ExpandableHeading ## Make an API call Performs an arbitrary authorized API call. | **Field** | **Description** | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Connection** | [Establish a connection to your Braze account](#). | | **URL** | Enter a path relative to `https://rest.iad-03.braze.com/`. For example: `/preference_center/v1/list`. | | **Method** | **GET: **to retrieve information for an entry
**POST:** to create a new entry
**PUT: **to update/replace an existing entry
**PATCH: **to make a partial entry update
**DELETE: **to delete an entry | | **Headers** | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. | | **Query String** | Enter the request query string. | | **Body** | Enter the body content for your API call. | :::