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-3757: Using an email address to trigger campaigns or Canvases GA [MERGE JAN 13] #8694

Merged
merged 1 commit into from
Jan 13, 2025
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 @@ -85,10 +85,6 @@ Authorization: Bearer YOUR-REST-API-KEY
- When `send_to_existing_only` is `true`, Braze will only send the message to existing users. However, this flag can't be used with user aliases.
- When `send_to_existing_only` is `false`, an attribute must be included. Braze will create a user with the `id` and attributes before sending the message.

{% alert important %}
Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
{% endalert %}

A user's subscription group status can be updated using the inclusion of a `subscription_groups` parameter within the `attributes` object. For more details, refer to [User attributes object]({{site.baseurl}}/api/objects_filters/user_attributes_object).

## Example request
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,6 @@ Authorization: Bearer YOUR-REST-API-KEY

Customers using the API for server-to-server calls may need to allowlist the appropriate API URL if they're behind a firewall.

{% alert important %}
Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
{% endalert %}

{% alert note %}
If you include both specific users in your API call and a target segment in the dashboard, the message will be sent to specifically the user profiles that are both in the API call and qualify for the segment filters.
{% endalert %}
Expand Down
4 changes: 0 additions & 4 deletions _docs/_api/objects_filters/recipient_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@ description: "This reference article explains the different components of the Br

Either `external_user_id`, `user_alias`, or `email` is required in this object. **Requests must specify only one.**

{% alert important %}
Specifying a recipient by email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
{% endalert %}

The recipients object allows you to combine the [user alias object]({{site.baseurl}}/api/objects_filters/user_alias_object/), the [trigger properties object]({{site.baseurl}}/api/objects_filters/trigger_properties_object/), and the [Canvas entry properties object]({{site.baseurl}}/api/objects_filters/canvas_entry_properties_object/).

## Object body
Expand Down