Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BD-1911: New User Update UI and use cases #4847

Merged
merged 3 commits into from
Feb 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,18 @@ The User Update component allows you to update a user’s attributes, events, an

With User Update, updates don't count towards your users or track per minute rate limit. Instead, these updates are batched so Braze can process them more efficiently than a Braze-to-Braze webhook. Note that this component does consume [data points]({{site.baseurl}}/user_guide/onboarding_with_braze/data_points/).

Users will only advance to downstream Canvas steps after the relevant user updates have been completed. If your downstream messaging relies on the user updates that you're making, you can ensure that these updates have been completed prior to when the messages send.
Users will only advance to the next Canvas steps after the relevant user updates have been completed. If your subsequent messaging relies on the user updates that you're making, you can ensure that these updates have been completed prior to when the messages send.

## Create a User Update

Drag and drop the component from the sidebar, or click the <i class="fas fa-plus-circle"></i> plus button at the bottom of the variant or step and select **User Update**.

There are three options that allow you to update existing, add new, or remove user profile information. All combined, the User Update steps in an app group can update up to 200,000 user profiles per minute.

{% alert tip %}
You can also test the changes made with this component by searching for a user and applying the change to them. This will update the user.
{% endalert %}

### Update custom attribute

To add or update a custom attribute, select an attribute name from your list of attributes and enter the key value.
Expand Down Expand Up @@ -54,25 +58,41 @@ You don't need to include sensitive data like your API key while using the JSON
* Braze cluster URL
* Fields related to push token imports

## Use case
## Use cases

### Set Canvas entry property as an attribute

For example, if we want a group of users to be promoted to loyalty members, select **Loyalty Member** as the attribute name, and select `True` as the corresponding key value. So, the users who enter this User Update step will have their VIP Member attribute updated to `True`.
You can use the user update step to persist a `canvas_entry_property`. Let’s say you have an event that triggers when an item is added to a cart. You can store the ID of the most recent item added to cart and use that for a remarketing campaign. Use the personalization feature to retrieve a Canvas entry property and store it in an attribute.

![][3]{: style="max-width:90%;"}
![][8]{: style="max-width:90%;"}

## Personalization features
#### Personalization

To store the property of the trigger event for a Canvas as an attribute, use the personalization modal to extract and store the Canvas entry property. This component also supports the following personalization features:
To store the property of the trigger event for a Canvas as an attribute, use the personalization modal to extract and store the Canvas entry property. User Update also supports the following personalization features:
* [Connected Content]({{site.baseurl}}/user_guide/personalization_and_dynamic_content/connected_content/)
* [Content Blocks]({{site.baseurl}}/user_guide/engagement_tools/templates_and_media/content_blocks/)
* [Entry properties]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/canvas_persistent_entry_properties/)
* Liquid logic (including [aborting messages]({{site.baseurl}}/user_guide/personalization_and_dynamic_content/liquid/aborting_messages/))
* Multiple attribute or event updates per object

### Increment numbers

This component can also be used to track the number of times a user has performed an event in increment and decrement numbers. For example, you could track the number of classes that a user has taken in a week. Using this component, the class count can reset at the start of the week and begin tracking again.

![][7]{: style="max-width:90%;"}

### Add to arrays

You can add or remove items from an array, and remove an item. For example, you could use this step to add to or remove items from a wishlist.

![][9]{: style="max-width:90%;"}

[1]: {% image_buster /assets/img_archive/canvas_user_update_step.png %}
[2]: {% image_buster /assets/img_archive/canvas_user_update_composer.png %}
[3]: {% image_buster /assets/img_archive/canvas_user_update_example.png %}
[4]: {% image_buster /assets/img_archive/canvas_user_update_update.png %}
[5]: {% image_buster /assets/img_archive/canvas_user_update_remove.png %}
[6]: {% image_buster /assets/img_archive/canvas_user_update_test_preview.png %}
[7]: {% image_buster /assets/img_archive/canvas_user_update_increment.png %}
[8]: {% image_buster /assets/img_archive/canvas_user_update_cep.png %}
[9]: {% image_buster /assets/img_archive/canvas_user_update_wishlist.png %}
Binary file added assets/img_archive/canvas_user_update_cep.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/img_archive/canvas_user_update_remove.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/img_archive/canvas_user_update_test_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/img_archive/canvas_user_update_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.