fix: take the broadcast id as a positional argument in recipients - #264
Merged
Conversation
The recipients method took broadcast_id inside the params dict. Every sibling GET with a path id takes a positional id: clicked_links, Attachments.list, Emails.share, Receiving.get. Align recipients and recipients_async with that convention. The method is merged but not released, so this is not a breaking change.
dielduarte
approved these changes
Aug 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Change
Broadcasts.recipients(params)toBroadcasts.recipients(id, params), and the same forrecipients_async. Removebroadcast_idfromRecipientsParams. Update the tests and both examples.Why
#261 put the broadcast id inside the params dict. Every sibling GET with a path id takes a positional id:
clicked_linksin the same class,Attachments.list,Emails.share,Receiving.get. The old shape also forced the impl to filter the id back out of the query dict.The method is merged but not released (no tag contains it), so the signature change is not breaking.
Verification
pytest --doctest-modules tests: 614 passed.flake8andmypy(CI flags): clean.type=sentreturns the recipient list, theemailsubstring filter works, and a bad id raisesResendError(404).Summary by cubic
Make Broadcasts.recipients and recipients_async take the broadcast id as a positional argument and remove broadcast_id from RecipientsParams. This aligns recipients with other path-id GETs and simplifies query construction.
Written for commit 5c2718c. Summary will update on new commits.