Skip to content

Document include_metrics and primary_purpose for Single-Email Campaigns #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wstrinz wants to merge 2 commits into from
+26 −1
Draft

Document include_metrics and primary_purpose for Single-Email Campaigns #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eef06f
Document include_metrics and primary_purpose for Single-Email Campaigns
wstrinz Oct 22, 2026
62084f5
Tighten the include_metrics and primary_purpose wording
wstrinz Oct 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion source/includes/rest/_broadcasts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ with [Set the audience](#set-the-audience).
<td><code>derived</code></td>
<td>Read-only text generated when the campaign is read. <code>derived.audience</code> describes who it goes to in plain English, such as <code>People who are in the "VIP customers" segment</code>, or <code>All people</code>. It is display text: do not parse it, and expect its wording to change.</td>
</tr>
<tr>
<td><code>metrics</code></td>
<td>Present only when the request includes <code>include_metrics=true</code>. An object with the campaign's <code>send_count</code>, <code>open_count</code>, <code>click_count</code> and <code>unsubscribe_count</code>.</td>
</tr>
<tr>
<td><code>links</code></td>
<td>An object containing the account's REST API URL.</td>
Expand Down Expand Up @@ -321,6 +325,10 @@ client.listBroadcasts(options)
<td><code>direction</code></td>
<td>Optional. Filter sort direction with: <code>asc</code> or <code>desc</code>. Defaults to <code>asc</code>.</td>
</tr>
<tr>
<td><code>include_metrics</code></td>
<td>Optional. Set to <code>true</code> to add a <code>metrics</code> object to each Single-Email Campaign.</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -546,7 +554,20 @@ client.fetchBroadcast(broadcastId)

### Arguments

None.
<table>
<thead>
<tr>
<th>Key</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>include_metrics</code></td>
<td>Optional. Set to <code>true</code> to add a <code>metrics</code> object to the Single-Email Campaign.</td>
</tr>
</tbody>
</table>

## Update a Single-Email Campaign

Expand Down Expand Up @@ -692,6 +713,10 @@ Status, scheduling, and the audience are not updated here. Each has its own endp
<td><code>postal_address</code></td>
<td>Optional. A physical mailing address for CAN-SPAM compliance.</td>
</tr>
<tr>
<td><code>primary_purpose</code></td>
<td>Optional. Either <code>commercial</code> or <code>transactional</code>. New Single-Email Campaigns are <code>commercial</code>, and only an update can change it. A <code>transactional</code> 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.</td>
</tr>
</tbody>
</table>

Expand Down
Loading