Skip to content

Update dependency @getbrevo/brevo to v6#322

Open
renovate[bot] wants to merge 1 commit into
mainfrom
renovate/getbrevo-brevo-6.x
Open

Update dependency @getbrevo/brevo to v6#322
renovate[bot] wants to merge 1 commit into
mainfrom
renovate/getbrevo-brevo-6.x

Conversation

@renovate

@renovate renovate Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Change Age Confidence
@getbrevo/brevo ^5.0.3^6.0.0 age confidence

Release Notes

getbrevo/brevo-node (@​getbrevo/brevo)

v6.0.2: - Empty Object Serialization Fix

Compare Source

Node.js SDK v6.0.2

What's New
🔧 Bug Fix: Empty Object Serialization
  • Fix: Empty JSON object serialization — objects with no properties now correctly serialize to {} instead of []
  • Resolves backend validation errors when sending empty optional/nested objects
✨ New Features: Consent Groups Management
  • List consent groups — GET /contacts/consent-groups
  • Create a consent group — POST /contacts/consent-groups
  • Get consent group details — GET /contacts/consent-groups/{id}
  • Update consent group — PUT /contacts/consent-groups/{id} (name, description, signup mode)
  • Delete consent group — DELETE /contacts/consent-groups/{id}
📲 Extended Operations
  • Import contacts — POST /contacts/import now accepts optional consentGroupIds field to add imported contacts to specified consent groups
  • Get contact details — GET /contacts/{identifier} now returns consentGroups array showing subscription status (when feature enabled)
💳 New Wallet Feature
  • Get pass installation URL — GET /wallet/passes/{passId}/installUrl/{contactId}
    • Generates per-contact wallet installation URLs
    • Enables sharing via email, SMS, or QR code for Apple Wallet/Google Wallet integration
Bug Fixes
  • Fixed serialization of empty optional/nullable objects to produce valid JSON objects instead of arrays
  • Resolves issues where backends strict on type validation would reject payloads containing empty nested objects
Compatibility
  • ✅ Backward compatible — no breaking changes
  • ✅ No API surface changes
  • ✅ No method signature changes
Installation
npm install @​getbrevo/[email protected]

v6.0.1

Compare Source

v6.0.1

First stable release of the v6 line. This is a major release with breaking changes — see the migration notes below before upgrading. v5.x remains supported and continues to receive wire-compatibility fixes.

npm install @​getbrevo/brevo@^6.0.1
Why this release

Most of the breaking changes in v6 come from an internal effort at Brevo to make our API endpoints, parameters and models more self-descriptive. The goal is to make the public surface easier to read at a glance — both for developers and for AI agents working against the Brevo API — so that names, shapes and required fields convey intent without needing to cross-reference external docs. Concretely, this means consistent camelCase parameters, payload wrappers that reflect what the endpoint actually does (e.g. { events: [...] }), filter keys that match the wire format, and model fields renamed or removed where the previous names were ambiguous or misleading.

We're aware that renaming costs callers a one-time migration, and we've kept v5.x supported so you can adopt v6 on your own timeline.

⚠️ Breaking changes

Companies — getCompanies filter parameter renamed

  • client.companies.getCompanies({ filters }) — the filters parameter is renamed to the bracketed literal "filters[attributes.name]" to match the wire format.
  • The old filters name still compiles but the filter is silently dropped server-side and you get an unfiltered list. Audit every call site.

Events — createBatchEvents payload shape changed

  • client.event.createBatchEvents now wraps events in { events: [...] } instead of accepting a raw array.

Balance — getActiveBalancesApi response and parameter rename

  • Response type replaced: BalanceLimitGetLoyaltyBalanceProgramsPidActiveBalanceResponse.
  • Request parameters renamed from snake_case to camelCase: contact_idcontactId, balance_definition_idbalanceDefinitionId, sort_fieldsortField.

Balance — getContactBalances requires balanceDefinitionId

  • balanceDefinitionId is now a required parameter.

CRM — getCrmTasktypes returns an array

  • client.tasks.getCrmTasktypes return type changed from a single object to GetCrmTasktypesResponseItem[].

Model fields removed

  • GetWebhook.channel
  • GetProcessResponseInfo.export
  • GetEventsList.events[].source
  • GetExtendedCampaignOverview.utmIDActive — replaced by utmID: number

Model fields renamed

  • ConversationsMessage.File.filenamename
  • ConversationsMessage.File.urllink
  • SendTransacSms.tag is now string | string[] (previously an object { field?: ... })

Now-required fields

  • GetContactDetails.whatsappBlacklisted
  • Note.text
  • Task.date
Added
  • BrevoClient auth option — inject a custom AuthProvider for advanced auth scenarios (OAuth, dynamic tokens, key rotation). The existing apiKey constructor option continues to work unchanged.
  • New optional fields and filters across contacts.createContact, contacts.updateContact, emailCampaigns.getEmailCampaigns, ecommerce.getProducts, and several other endpoints.
Migration

See the Upgrading from v5.x guide for full migration details, including a one-line rollback pin if you need to hold on v5.x temporarily.

Documentation

What's Changed

Full Changelog: getbrevo/brevo-node@v5.0.4...v6.0.0

What's Changed

Full Changelog: getbrevo/brevo-node@v3.0.1...v6.0.0


Configuration

📅 Schedule: (UTC)

  • Branch creation
    • At any time (no schedule defined)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

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.

0 participants