diff --git a/source/includes/rest/_broadcasts.md b/source/includes/rest/_broadcasts.md index 030220eb6c9..039809a7e19 100644 --- a/source/includes/rest/_broadcasts.md +++ b/source/includes/rest/_broadcasts.md @@ -157,6 +157,10 @@ with [Set the audience](#set-the-audience). derived Read-only text generated when the campaign is read. derived.audience describes who it goes to in plain English, such as People who are in the "VIP customers" segment, or All people. It is display text: do not parse it, and expect its wording to change. + + metrics + Present only when the request includes include_metrics=true. An object with the campaign's send_count, open_count, click_count and unsubscribe_count. + links An object containing the account's REST API URL. @@ -321,6 +325,10 @@ client.listBroadcasts(options) direction Optional. Filter sort direction with: asc or desc. Defaults to asc. + + include_metrics + Optional. Set to true to add a metrics object to each Single-Email Campaign. + @@ -546,7 +554,20 @@ client.fetchBroadcast(broadcastId) ### Arguments -None. + + + + + + + + + + + + + +
KeyDescription
include_metricsOptional. Set to true to add a metrics object to the Single-Email Campaign.
## Update a Single-Email Campaign @@ -692,6 +713,10 @@ Status, scheduling, and the audience are not updated here. Each has its own endp postal_address Optional. A physical mailing address for CAN-SPAM compliance. + + primary_purpose + Optional. Either commercial or transactional. New Single-Email Campaigns are commercial, and only an update can change it. A transactional campaign also goes to people who have unsubscribed, so use it only for messages people need regardless of their email preferences, such as receipts or account notices. +