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).
derivedderived.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.metricsinclude_metrics=true. An object with the campaign's send_count, open_count, click_count and unsubscribe_count.linksdirectionasc or desc. Defaults to asc.include_metricstrue to add a metrics object to each Single-Email Campaign.| Key | +Description | +
|---|---|
include_metrics |
+ Optional. Set to true to add a metrics object to the Single-Email Campaign. |
+
postal_addressprimary_purposecommercial 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.