Skip to content

Document include_metrics and primary_purpose for Single-Email Campaigns - #135

Draft
wstrinz wants to merge 2 commits into
apidocs-l1-tags-v2-pathfrom
apidocs-l1b-broadcast-params
Draft

wstrinz wants to merge 2 commits into
apidocs-l1-tags-v2-pathfrom
apidocs-l1b-broadcast-params

Conversation

@wstrinz

@wstrinz wstrinz commented Oct 22, 2026 •

Copy link
Copy Markdown

Part of:

Documents changes here:

Background

  • Listing and fetching Single-Email Campaigns accepts include_metrics, which adds send, open, click and unsubscribe counts to each campaign. It isn't documented.
  • Updating a Single-Email Campaign accepts primary_purpose, either commercial or transactional. It isn't documented either, and the docs should say that a transactional campaign also goes to people who have unsubscribed.

Modification

  • Adds the metrics property, and include_metrics to the List and Fetch arguments. Fetch previously listed no arguments.
  • Adds primary_purpose to the Update arguments: its two values, that new campaigns are commercial, and that transactional is only for messages people need regardless of their email preferences.

Result

  • Both parameters are documented on the endpoints that take them.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant