From 8eef06f0cff8c4bfc01134d81053bfec16e2caa2 Mon Sep 17 00:00:00 2001 From: Will Strinz Date: Thu, 22 Oct 2026 12:47:15 -0500 Subject: [PATCH] Document include_metrics and primary_purpose for Single-Email Campaigns Co-Authored-By: Claude Opus 5.5 --- source/includes/rest/_broadcasts.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/source/includes/rest/_broadcasts.md b/source/includes/rest/_broadcasts.md index 030220eb6c9..93b43af4565 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. Include include_metrics=true to add a metrics object to each Single-Email Campaign; leave it out to omit them. + @@ -546,7 +554,20 @@ client.fetchBroadcast(broadcastId) ### Arguments -None. + + + + + + + + + + + + + +
KeyDescription
include_metricsOptional. Include include_metrics=true to add a metrics object to the Single-Email Campaign; leave it out to omit it.
## 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. A transactional Single-Email Campaign's audience also includes people who have unsubscribed. Use transactional only for messages a person needs whatever their email preferences, such as receipts or account notices. New Single-Email Campaigns are created as commercial. +