From cfa929df96dccbf9d77cee0a165be704d75c5b24 Mon Sep 17 00:00:00 2001 From: Lydia Xie Date: Wed, 5 Feb 2025 14:50:55 -0800 Subject: [PATCH 1/2] BD-3906 and BD-3839: Clarifying prioritization array for email as identifier --- .../messaging/send_messages/post_send_triggered_campaigns.md | 2 +- .../messaging/send_messages/post_send_triggered_canvases.md | 2 +- 2 files changed, 2 insertions(+), 2 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 5e9f6b36187..cc8fa525e98 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 @@ -77,7 +77,7 @@ Authorization: Bearer YOUR-REST-API-KEY |`trigger_properties`| Optional | Object | See [trigger properties]({{site.baseurl}}/api/objects_filters/trigger_properties_object/). Personalization key-value pairs that will apply to all users in this request. | |`broadcast`| Optional | Boolean | You must set `broadcast` to true when sending a message to an entire segment that a campaign or Canvas targets. This parameter defaults to false (as of August 31, 2017).

If `broadcast` is set to true, a `recipients` list cannot be included. However, use caution when setting `broadcast: true`, as unintentionally setting this flag may cause you to send your message to a larger than expected audience. | |`audience`| Optional | Connected audience object| See [connected audience]({{site.baseurl}}/api/objects_filters/connected_audience/). | -|`recipients`| Optional | Array | See [recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/).

If `send_to_existing_only` is `false`, an attribute object must be included.

If `recipients` is not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the campaign. | +|`recipients`| Optional | Array | See [recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/).

If `send_to_existing_only` is `false`, an attribute object must be included.

If `recipients` is not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the campaign.

If `email` is the identifier, you must include [`prioritization`]({{site.baseurl}}/api/endpoints/user_data/post_user_identify#identifying-users-by-email) in the recipients object. | |`attachments`| Optional | Array | If `broadcast` is set to true, then the `attachments` list cannot be included. | {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" } 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 fdec105cd11..ad20c62be60 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 @@ -67,7 +67,7 @@ Authorization: Bearer YOUR-REST-API-KEY |`canvas_entry_properties`| Optional | Object | See [Canvas entry properties]({{site.baseurl}}/api/objects_filters/canvas_entry_properties_object/). Personalization key-value pairs will apply to all users in this request. The Canvas entry properties object has a maximum size limit of 50 KB. | |`broadcast`| Optional | Boolean | You must set `broadcast` to true when sending a message to an entire segment that a campaign or Canvas targets. This parameter defaults to false (as of August 31, 2017).

If `broadcast` is set to true, a `recipients` list cannot be included. However, use caution when setting `broadcast: true`, as unintentionally setting this flag may cause you to send your message to a larger-than-expected audience. | |`audience`| Optional| Connected audience object | See [Connected audience]({{site.baseurl}}/api/objects_filters/connected_audience/). | -|`recipients`| Optional | Array | See [Recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/). If not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the Canvas.

The `recipients` array may contain up to 50 objects, with each object containing a single `external_user_id` string and a `canvas_entry_properties` object. Either `external_user_id` or `user_alias` is required for this call. Requests must specify only one.

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` and a user with the given `id` does not exist, Braze will create a user with that ID and attributes before sending the message.| +|`recipients`| Optional | Array | See [Recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/). If not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the Canvas.

The `recipients` array may contain up to 50 objects, with each object containing a single `external_user_id` string and a `canvas_entry_properties` object. One of `external_user_id`, `user_alias`, or `email` is required for this call. Requests must specify only one.

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` and a user with the given `id` does not exist, Braze will create a user with that ID and attributes before sending the message.

If `email` is the identifier, you must include [`prioritization`]({{site.baseurl}}/api/endpoints/user_data/post_user_identify#identifying-users-by-email) in the recipients object. | {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" } Customers using the API for server-to-server calls may need to allowlist the appropriate API URL if they're behind a firewall. From fbe47ec08b1950c0f9a4c7782ba6c74db1b83544 Mon Sep 17 00:00:00 2001 From: Lydia Xie <87040416+lydia-xie@users.noreply.github.com> Date: Wed, 5 Feb 2025 14:58:05 -0800 Subject: [PATCH 2/2] 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 ad20c62be60..dceccbec804 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 @@ -67,7 +67,7 @@ Authorization: Bearer YOUR-REST-API-KEY |`canvas_entry_properties`| Optional | Object | See [Canvas entry properties]({{site.baseurl}}/api/objects_filters/canvas_entry_properties_object/). Personalization key-value pairs will apply to all users in this request. The Canvas entry properties object has a maximum size limit of 50 KB. | |`broadcast`| Optional | Boolean | You must set `broadcast` to true when sending a message to an entire segment that a campaign or Canvas targets. This parameter defaults to false (as of August 31, 2017).

If `broadcast` is set to true, a `recipients` list cannot be included. However, use caution when setting `broadcast: true`, as unintentionally setting this flag may cause you to send your message to a larger-than-expected audience. | |`audience`| Optional| Connected audience object | See [Connected audience]({{site.baseurl}}/api/objects_filters/connected_audience/). | -|`recipients`| Optional | Array | See [Recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/). If not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the Canvas.

The `recipients` array may contain up to 50 objects, with each object containing a single `external_user_id` string and a `canvas_entry_properties` object. One of `external_user_id`, `user_alias`, or `email` is required for this call. Requests must specify only one.

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` and a user with the given `id` does not exist, Braze will create a user with that ID and attributes before sending the message.

If `email` is the identifier, you must include [`prioritization`]({{site.baseurl}}/api/endpoints/user_data/post_user_identify#identifying-users-by-email) in the recipients object. | +|`recipients`| Optional | Array | See [Recipients object]({{site.baseurl}}/api/objects_filters/recipient_object/). If not provided and `broadcast` is set to true, the message will be sent to the entire segment targeted by the Canvas.

The `recipients` array may contain up to 50 objects, with each object containing a single `external_user_id` string and a `canvas_entry_properties` object. This call requires an `external_user_id`, `user_alias`, or `email`. Requests must specify only one.

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` and a user with the given `id` does not exist, Braze will create a user with that ID and attributes before sending the message.

If `email` is the identifier, you must include [`prioritization`]({{site.baseurl}}/api/endpoints/user_data/post_user_identify#identifying-users-by-email) in the recipients object. | {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4 role="presentation" } Customers using the API for server-to-server calls may need to allowlist the appropriate API URL if they're behind a firewall.