From b5cbdce12a5ac44f24fc4ec128bb674af3d5cca5 Mon Sep 17 00:00:00 2001 From: Dave Hensley Date: Fri, 27 Sep 2024 12:00:28 -0400 Subject: [PATCH 1/4] CO-2975 Allow recipients to be specified via email. --- .../send_messages/post_send_triggered_campaigns.md | 8 +++++++- .../send_messages/post_send_triggered_canvases.md | 8 +++++++- _docs/_api/objects_filters/recipient_object.md | 9 ++++++++- 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md index 6e023c7d47e..3ecb52e04f7 100644 --- a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md +++ b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md @@ -48,9 +48,11 @@ Authorization: Bearer YOUR-REST-API-KEY "recipients": (optional, array; if not provided and broadcast is not set to `false`, message will send to the entire segment targeted by the campaign) [ { - // Either "external_user_id" or "user_alias" is required. Requests must specify only one. + // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one. "user_alias": (optional, user alias object) user alias of user to receive message, "external_user_id": (optional, string) external identifier of user to receive message, + "email": (optional, string) email address of user to receive message, + "prioritization": (optional, array) prioritization array; required when using email, "trigger_properties": (optional, object) personalization key-value pairs that will apply to this user (these key-value pairs will override any keys that conflict with the parent trigger_properties), "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases; if set to `false`, an attributes object must also be included, "attributes": (optional, object) fields in the attributes object will create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values will be overwritten @@ -83,6 +85,10 @@ 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 via 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 via 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 diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md index f3ce2e2f04c..95d8aba66d2 100644 --- a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md +++ b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md @@ -46,9 +46,11 @@ Authorization: Bearer YOUR-REST-API-KEY // Including 'audience' will only send to users in the audience "recipients": (optional, array; if not provided and broadcast is not set to 'false', message will send to the entire segment targeted by the Canvas) [{ - // Either "external_user_id" or "user_alias" is required. Requests must specify only one. + // Either "external_user_id" or "user_alias" or "email" is required. Requests must specify only one. "user_alias": (optional, user alias object) user alias of user to receive message, "external_user_id": (optional, string) external identifier of user to receive message, + "email": (optional, string) email address of user to receive message, + "prioritization": (optional, array) prioritization array; required when using email, "canvas_entry_properties": (optional, object) personalization key-value pairs that will apply to this user (these key-value pairs will override any keys that conflict with the parent `canvas_entry_properties`) "send_to_existing_only": (optional, boolean) defaults to true, can't be used with user aliases "attributes": (optional, object) fields in the attributes object will create or update an attribute of that name with the given value on the specified user profile before the message is sent and existing values will be overwritten @@ -70,6 +72,10 @@ 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 via 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 send to specifically the user profiles that are both in the API call and qualify for the segment filters. {% endalert %} diff --git a/_docs/_api/objects_filters/recipient_object.md b/_docs/_api/objects_filters/recipient_object.md index 83ba5ee50fc..c965f94f4a7 100644 --- a/_docs/_api/objects_filters/recipient_object.md +++ b/_docs/_api/objects_filters/recipient_object.md @@ -11,7 +11,11 @@ description: "This reference article explains the different components of the Br > The recipients object allows you to request or write information in our endpoints. -Either `external_user_id` or `user_alias` is required in this object. **Requests must specify only one.** +Either `external_user_id`, `user_alias`, or `email` is required in this object. **Requests must specify only one.** + +{% alert important %} +Specifying a recipient via 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/). @@ -21,6 +25,8 @@ The recipients object allows you to combine the [user alias object]({{site.baseu [{ "user_alias": (optional, User Alias Object) User alias of user to receive message, "external_user_id": (optional, string) see External user ID, + "email": (optional, string) email address of user to receive message, + "prioritization": (optional, array) see Prioritization; required when using email, "trigger_properties": (optional, object) personalization key-value pairs for this user when sending a campaign or message; see Trigger Properties, "canvas_entry_properties": (optional, object) personalization key-value pairs for this user when triggering a Canvas; see Canvas Entry Properties }] @@ -28,6 +34,7 @@ The recipients object allows you to combine the [user alias object]({{site.baseu - [User aliases]({{site.baseurl}}/user_guide/data_and_analytics/user_data_collection/user_profile_lifecycle/#user-aliases) - [External user ID]({{site.baseurl}}/api/objects_filters/user_attributes_object/#braze-user-profile-fields) +- [Prioritization]({{site.baseurl}}/api/endpoints/user_data/post_user_identify/#identifying-users-by-email) ## Recipient object deduping From a1b28b950dbf9214d063f574edc9c7f840301420 Mon Sep 17 00:00:00 2001 From: Lydia Xie <87040416+lydia-xie@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:52:33 -0400 Subject: [PATCH 2/4] Update _docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md --- .../messaging/send_messages/post_send_triggered_campaigns.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md index 3ecb52e04f7..5e2d45c88d6 100644 --- a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md +++ b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_campaigns.md @@ -86,7 +86,7 @@ Authorization: Bearer YOUR-REST-API-KEY - 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 via email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access. ++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 via 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). From f62110f036ca7dd76be4ceaf3b436d54fd3eeca2 Mon Sep 17 00:00:00 2001 From: Lydia Xie <87040416+lydia-xie@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:52:59 -0400 Subject: [PATCH 3/4] Update _docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md --- .../messaging/send_messages/post_send_triggered_canvases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md index 95d8aba66d2..1a3a86fab90 100644 --- a/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md +++ b/_docs/_api/endpoints/messaging/send_messages/post_send_triggered_canvases.md @@ -73,7 +73,7 @@ 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 via email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access. ++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 %} From eb5ff9fcd36cf8e6c52d0eb86791a7fca5464e51 Mon Sep 17 00:00:00 2001 From: Lydia Xie <87040416+lydia-xie@users.noreply.github.com> Date: Tue, 8 Oct 2024 10:53:13 -0400 Subject: [PATCH 4/4] Update _docs/_api/objects_filters/recipient_object.md --- _docs/_api/objects_filters/recipient_object.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/_api/objects_filters/recipient_object.md b/_docs/_api/objects_filters/recipient_object.md index c965f94f4a7..6d698338ec6 100644 --- a/_docs/_api/objects_filters/recipient_object.md +++ b/_docs/_api/objects_filters/recipient_object.md @@ -14,7 +14,7 @@ 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 via email address is currently in early access. Contact your customer success manager if you're interested in participating in this early access. +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/).