fix(api-keys): rename the update params key to id - #269
Merged
Conversation
Every other update params dict uses the id key (domains, emails, templates, contact_properties); api_keys shipped api_key_id in v2.40.0. Rename it while the method is one day old. The remove positional parameter keeps its name; positional id names ship in both forms across the SDK.
Contributor
There was a problem hiding this comment.
No issues found across 5 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Requires human review: Renames the api_key_id parameter to id in the update/update_async methods and public UpdateParams TypedDict, aligning with SDK convention but breaking the v2.40.0 request shape.
Re-trigger cubic
gabrielmfern
approved these changes
Aug 25, 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
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
ApiKeys.updatetakesparams["api_key_id"]; every other update params dict in the SDK usesid:This renames the key to
idin the TypedDict, both method bodies, the tests, and both examples, and bumps the version to 2.40.2.Why a clean rename is safe
The method shipped yesterday (v2.40.0, 2026-08-24). Datadog traces for
PATCH /api-keys/:apiKeyIdsince then show 33 requests; the indexed spans group into two user agents,nodeandresend-remote-mcp:1.0.0. Zero calls from resend-python. There is nobody to break, so no deprecation alias.Scope
remove(api_key_id=...)keeps its name: positional id parameters ship in both forms across the SDK (idin audiences/broadcasts/contact_properties,<resource>_idin domains/emails/automations), and its kwarg form is long documented.Checks
pytest 614 passed; mypy clean; flake8 clean (flake8 7.x locally, CI pins <5).
Follow-up: the Python tab on docs update-api-key.mdx teaches
"api_key_id"and needs the same rename when this releases.