Marketing
Braze
Braze modules
8min
after connecting to the braze app, you can use the following modules to build your {{scenario plural lowercase}} users 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 braze 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 list catalogs gets a list of all catalogs f ield description connection braze docid 4s1tky14wtportvskr5mp limit set the maximum number of results make will return during one execution cycle create a catalog creates a new catalog field description connection braze 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 delete a catalog deletes a catalog given its name field description connection braze docid 4s1tky14wtportvskr5mp catalog name enter or map the name of the catalog that you want to delete catalog items list catalog items gets a list of items inside a given catalog field description connection braze 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 get a catalog item gets a catalog item given its id field description connection braze 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 create or update a catalog item creates or updates a catalog item given its id field description connection braze 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 delete a catalog item deletes a catalog item given its id field description connection braze 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 send a campaign message sends a message from a given campaign field description connection braze 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 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 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