Skip to content

feat: add broadcasts.recipients() method - #261

Open
dielduarte wants to merge 1 commit into
mainfrom
feat/broadcasts-recipients
Open

feat: add broadcasts.recipients() method#261
dielduarte wants to merge 1 commit into
mainfrom
feat/broadcasts-recipients

Conversation

@dielduarte

@dielduarte dielduarte commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Adds Broadcasts.recipients() / recipients_async() for GET /broadcasts/{id}/recipients.

Spec: resend/resend-openapi#97
Node reference: resend/resend-node#1078

Tests: 584 passed. flake8 + mypy clean.


Summary by cubic

Adds resend.Broadcasts.recipients() and resend.Broadcasts.recipients_async() to list a broadcast’s recipients by event type with filters and cursor pagination. Previously recipient-level delivery and engagement data was not available; now clients can query delivered, opened, clicked, bounced, and more, including counts and clicked links when applicable.

  • Public API: adds RecipientsParams and RecipientsResponse, plus BroadcastRecipient, BroadcastRecipientEventType, BroadcastRecipientBounceType, and BroadcastRecipientClickedLink (exported via resend.__init__).
  • Filtering and pagination: requires type; supports email, bounce_type (only when type="bounced"), limit (1–100), and cursor params after/before (mutually exclusive). broadcast_id goes in the path; other params go in the query.
  • Response shape: returns object="list", data: List[BroadcastRecipient], and has_more. Optional fields: count for opened/clicked, bounce_type for bounced, and clicked_links for clicked.
  • Examples and tests: adds sync/async examples; tests cover success cases, pagination, optional fields, 404 errors, and empty content errors.

Written for commit 4abdc68. Summary will update on new commits.

Review in cubic

Wraps GET /broadcasts/{id}/recipients to list a broadcast's recipients
for a given event type, with support for email/bounce_type filters
and cursor pagination.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Requires human review: Adds new recipients and recipients_async methods to the Broadcasts module, along with supporting data models and tests for the new API endpoint.

Re-trigger cubic

@dielduarte
dielduarte marked this pull request as ready for review August 22, 2026 01:54
@github-actions github-actions Bot added the linear-synced PR has been synced to Linear label Aug 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

linear-synced PR has been synced to Linear

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant