Brevo API changelog - seamless.engineering

Loyalty subscription details and image gallery naming guidance

Thu, 17 Sep 2026 12:00:00 GMT

New feature (2026-09-02). GET /loyalty/config/programs/{pid}/account-info response now includes loyalty program name, membership object, and enhanced reward fields with better naming guidance.

Recover a project with brevo app scaffold

Mon, 07 Sep 2026 12:00:00 GMT

New feature (2026-08-13). New 'brevo app scaffold --app-id' command sets up project directories for existing apps and supports interactive app selection.

Loyalty transaction status renamed

Thu, 03 Sep 2026 12:00:00 GMT

Breaking (2026-09-03). Transaction status enum values changed from 'pending'/'complete' to 'draft'/'completed', requiring code updates for status checks.

Loyalty subscription details and image gallery naming guidance

Wed, 02 Sep 2026 12:00:00 GMT

New feature (2026-09-02). Get subscription info endpoint response now includes loyalty program name, membership object, new reward fields (publicDescription, unit, value), and additional field names alongside IDs.

Get the records associated with an object record

Wed, 19 Aug 2026 12:00:00 GMT

New feature (2026-08-14). New endpoint GET /v3/objects/{object_type}/associated-records returns records associated with a single source record with filtering and pagination support.

brevo app create asks separately before scaffolding

Fri, 14 Aug 2026 12:00:00 GMT

Breaking (2026-08-13). brevo app create now writes base project first, then separately asks whether to scaffold the Test OAuth App; non-interactive runs stay base-only.

brevo app upload replaces brevo app update

Fri, 14 Aug 2026 12:00:00 GMT

Breaking (2026-08-13). New 'brevo app upload' command replaces 'brevo app update' with diff preview; old command-line flags removed and app-config.json schema changed (redirectUrls→redirectUris, distribution→distribution_type).

Recover a project with brevo app scaffold

Fri, 14 Aug 2026 12:00:00 GMT

New feature (2026-08-13). New 'brevo app scaffold' command allows setting up project folder for existing apps on new machines or after losing project files.

Deals API — filter by owner, stage, and pipeline

Wed, 12 Aug 2026 12:00:00 GMT

New feature (2026-07-02). GET /crm/deals now documents three additional query filters: filters[attributes.deal_owner], filters[attributes.deal_stage], and filters[attributes.pipeline].

Product import guide now documents alternativePrice

Fri, 07 Aug 2026 12:00:00 GMT

Other (2026-08-06). Documentation updated to include alternativePrice field (float) for secondary pricing in product import endpoints.

JS Tracker — document EXT_ID in Brevo.identify()

Mon, 03 Aug 2026 12:00:00 GMT

Other (2026-07-30). Documentation added for passing external identifiers (EXT_ID) alongside email_id in identify() method.

Transactional Email — clarified contactPixelTrackingConsent behavior

Wed, 22 Jul 2026 12:00:00 GMT

Other (2026-07-21). Clarified documentation for per-recipient contactPixelTrackingConsent field behavior regarding open tracking consent and anonymization.

Email Campaigns — UTM parameter customization

Mon, 20 Jul 2026 12:00:00 GMT

New feature (2026-07-20). New optional fields utmCampaign, utmContent, and utmTerm allow customization of UTM tracking parameters in email campaigns.

Transactional Email — per-contact pixel tracking consent

Mon, 20 Jul 2026 12:00:00 GMT

New feature (2026-07-20). New contactPixelTrackingConsent field added to transactional email endpoint to control whether recipient opens are tracked identifiably or anonymized.

Brevo CLI v2.0.0 — upgrade notice

Thu, 02 Jul 2026 12:00:00 GMT

Breaking (2026-07-02). Major CLI version 2.0.0 released with breaking changes; users on v1.1.1 or earlier must upgrade as some commands may not work as expected.

Deals API — filter by owner, stage, and pipeline

Thu, 02 Jul 2026 12:00:00 GMT

New feature (2026-07-02). GET /crm/deals now supports three additional query filters: deal_owner, deal_stage, and pipeline for server-side filtering.

Consent Groups API and Wallet pass install URLs

Wed, 01 Jul 2026 12:00:00 GMT

New feature (2026-06-30). New endpoints and fields added for managing consent groups and generating wallet pass installation URLs.

Connect to Cursor guide

Wed, 24 Jun 2026 12:00:00 GMT

New feature (2026-02-09). Added documentation for connecting Brevo API to Cursor IDE via MCP server for direct API documentation access.

Dedicated rate limits for orders and products endpoints

Wed, 24 Jun 2026 12:00:00 GMT

Other (2026-02-10). Added dedicated rate limits for POST /v3/orders/status and POST /v3/products endpoints that differ from default limits.

Loyalty API guides

Wed, 24 Jun 2026 12:00:00 GMT

New feature (2026-03-04). Added new Loyalty section to Guides with six pages covering full Loyalty API integration workflow.

OAuth apps now support scopes

Wed, 03 Jun 2026 12:00:00 GMT

New feature (2026-06-03). OAuth apps can now declare scopes to specify permissions requested from Brevo users, shown on consent screen and embedded in access tokens.

SDK updates

Sun, 17 May 2026 12:00:00 GMT

New feature (2026-03-25). Node.js v5.0.3, PHP v4.0.11, Python v4.0.9: New endpoints, fields, and API improvements across Node.js, PHP, and Python SDKs.

Major SDK releases

Fri, 15 May 2026 12:00:00 GMT

Breaking (2026-05-14). Node.js v6.0.0, PHP v5.0.0, Python v5.0.0: Opt-in major SDK releases with breaking changes; existing v4.x/v5.x integrations unaffected unless upgraded.

Batch events body wrapper, contact merge ID response, and loyalty transaction filter

Wed, 13 May 2026 12:00:00 GMT

Breaking (2026-04-21). POST /events/batch request body schema changed from array format to wrapped object format with 'events' key; event_name and identifiers now explicitly required.

Contacts category attributes

Tue, 12 May 2026 12:00:00 GMT

Breaking (2026-05-01). valueStr field, and Ecommerce product search and alternative price: GET /contacts/attributes now returns 0 for non-numeric category values; migrate to new valueStr field for unique identifier distinction.

Contacts category attributes

Tue, 12 May 2026 12:00:00 GMT

Breaking (2026-05-01). valueStr field: GET /contacts/attributes now returns 0 for non-numeric category values; clients must migrate to new valueStr field for correct enum distinction.

Coupons webhooks documentation

Tue, 12 May 2026 12:00:00 GMT

New feature (2026-04-27). Added documentation for new unique_coupon_sent marketing webhook event triggered when unique coupon codes are sent to contacts.

Deprecation Notice

Tue, 12 May 2026 12:00:00 GMT

Deprecation (2026-05-12). POST /contacts/batch: POST /contacts/batch endpoint deprecated effective 2026-10-30, replaced by newer POST /v3/contacts/import API.

Ecommerce, Events, and Loyalty API updates

Tue, 12 May 2026 12:00:00 GMT

Breaking (2026-03-21). Added two new product fields (brand and description) to POST /products, POST /products/batch, and GET /products/{id} endpoints.

Deprecation

Mon, 11 May 2026 12:00:00 GMT

Deprecation (2026-03-12). transactional SMS synchronous methods: Synchronous SMS methods (sendTransacSms/send_transac_sms) deprecated in favor of async variants across Node.js, PHP, and Python SDKs.

SDK updates

Fri, 08 May 2026 12:00:00 GMT

Bug fix (2026-03-12). Node.js v5.0.1, PHP v4.0.10, Python v4.0.7: Bug fixes, type corrections, and deprecations across all three official SDKs.

SDK bug fixes

Mon, 04 May 2026 12:00:00 GMT

Bug fix (2026-04-10). Node.js v5.0.5, PHP v4.0.14, Python v4.0.11: Bug fixes for process endpoints duplicate_email_id typing, event endpoints boolean value handling, and contact endpoints integer attribute handling.

Batch event creation

Tue, 28 Apr 2026 12:00:00 GMT

New feature (2026-03-03). Added POST /events/batch endpoint allowing multiple events in a single request with partial success support via 207 status response.

Batch events body wrapper

Sat, 25 Apr 2026 12:00:00 GMT

Breaking (2026-04-21). POST /events/batch request body schema changed; events array must now be wrapped under an 'events' key with event_name and identifiers marked as required.

Events API GET endpoint

Sat, 25 Apr 2026 12:00:00 GMT

New feature (2026-03-21). Added new `GET /events` endpoint to retrieve events filtered by contact, name, object type, or date range with pagination support.

Transactional SMS synchronous method deprecated

Sat, 25 Apr 2026 12:00:00 GMT

Deprecation (2026-03-12). Deprecated synchronous `sendTransacSms()` methods across all SDKs; recommend using async variants instead.

Batch events partial success status renamed

Fri, 24 Apr 2026 12:00:00 GMT

Breaking (2026-03-21). Batch events 207 response status field renamed from `partialSuccess` to `partiallyQueued`.

Batch events body wrapper, contact merge ID response, and loyalty transaction filter

Tue, 21 Apr 2026 12:00:00 GMT

Breaking (2026-04-21). Breaking change to POST /events/batch request body (now requires events wrapper), new getId field on contact creation, and new loyaltySubscriptionId filter parameter.

Create contact merge ID response

Tue, 21 Apr 2026 12:00:00 GMT

New feature (2026-04-21). Added new `getId` field to POST /contacts endpoint that returns the surviving contact ID after merge when `getId: true` and `forceMerge: true` are set.

Loyalty transaction history filter

Tue, 21 Apr 2026 12:00:00 GMT

New feature (2026-04-21). New `loyaltySubscriptionId` query parameter added to loyalty transaction history endpoint for filtering by specific subscription.

Loyalty transaction list filters

Mon, 20 Apr 2026 12:00:00 GMT

New feature (2026-03-21). Added `status` and `transactionType` filters to loyalty transaction history; `offset` parameter now represents page number instead of record skip.

Batch events response code change

Sun, 19 Apr 2026 12:00:00 GMT

Breaking (2026-03-21). POST /events/batch successful response changed from `204 No Content` to `202 Accepted` with JSON body containing message and event count.

Process endpoint 404 error code correction

Sun, 19 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). Breaking change: `GET /processes/{processId}` 404 error code corrected from `invalid_parameter` to `document_not_found`.

Product metaInfo character limit updated

Sun, 19 Apr 2026 12:00:00 GMT

Breaking (2026-03-21). Product `metaInfo` field size limit changed from 1000 KB to 20,000 characters total across all keys and values.

Account endpoint dateTimePreferences removal

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). Breaking change: dateTimePreferences object (timezone, timeFormat, dateFormat) removed from GET /account response; startDate, endDate, users removed from required fields in plan objects.

API specification overhaul

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). accuracy, completeness, and breaking corrections: Major OpenAPI specification rework correcting inaccuracies between spec and actual API behavior; generated SDK types will change.

Domain creation validation format change

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). Changed domain name validation from custom regex pattern to `format: hostname` in domain creation endpoint.

Export webhook history messageId type correction

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). POST /webhooks/export `messageId` field corrected from integer to string type.

Feeds endpoint field removals

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). Removed fields `alias`, `isInternal`, `personalization`, `defaultAttr`, and `defaultContact` from GET /feeds and GET /feeds/{uuid} responses as they are not returned by the API.

Pagination minimums increased

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). limit minimum on GET /processes and maxRetries minimum on feed endpoints raised from 0 to 1.

Process endpoints info fields type correction

Fri, 17 Apr 2026 12:00:00 GMT

Breaking (2026-04-17). Breaking change: import `info` fields (invalid_emails, duplicate_contact_id, etc.) on process endpoints now return `string` (URL to CSV report) instead of `integer`.

Webhook associations unlink action support

Fri, 17 Apr 2026 12:00:00 GMT

New feature (2026-04-17). Associations in PUT /crm/objects endpoint now support `action` field (`link` or `unlink`) enabling association removal in upsert requests.

Product brand and description fields

Thu, 16 Apr 2026 12:00:00 GMT

New feature (2026-03-21). New `brand` and `description` fields added to product endpoints; metaInfo character limit changed from 1000 KB to 20,000 characters.

Loyalty API

Tue, 14 Apr 2026 12:00:00 GMT

New feature (2026-03-21). internal balance definitions and tier groups: Balance definitions and tier groups now support meta object with isInternal flag; includeInternal query parameter added to balance and member endpoints.

Conversations webhooks documentation update

Sun, 12 Apr 2026 12:00:00 GMT

Other (2026-02-13). Updated Conversations webhooks documentation with new message fields including rawUnsafeHtml, subject, isSentViaJsApi, sourceMessageId, email headers, and isForward.

Ecommerce, Events, and Loyalty API updates

Sat, 11 Apr 2026 12:00:00 GMT

Breaking (2026-03-21). New product brand and description fields with metaInfo limit changed to 20,000 characters; new GET /events endpoint; breaking changes to POST /events/batch response code (204→202) and status field rename (partialSuccess→partiallyQueued); Loyalty internal balance definitions and transaction filters added.

SDK bug fixes

Fri, 10 Apr 2026 12:00:00 GMT

Bug fix (2026-04-10). Node.js, PHP, Python: Multiple SDK releases with fixes for process endpoint field types, event properties boolean handling, and contact attribute integer handling.

Deprecation

Mon, 06 Apr 2026 12:00:00 GMT

Deprecation (2026-03-12). synchronous transactional SMS methods: Deprecated sendTransacSms() methods across Node.js, PHP, and Python SDKs in favor of async variants (sendTransacSmsAsync/sendAsyncTransactionalSms).

MCP server authentication method changed

Mon, 06 Apr 2026 12:00:00 GMT

Breaking (2026-03-02). MCP tokens now transmitted via Authorization Bearer header instead of URL path; previous URL patterns no longer valid.

SDK createContact 204 response handling

Mon, 06 Apr 2026 12:00:00 GMT

Bug fix (2026-03-12). createContact() across Node.js, PHP, Python SDKs now correctly handles 204 No Content responses without JSON parse errors.

Conversations webhooks

Sun, 05 Apr 2026 12:00:00 GMT

New feature (2026-02-13). imageInfo.previewUrl renamed: Field imageInfo.previewUrl renamed to imageInfo.previewLink in conversation transcript payload.

Loyalty API

Sun, 05 Apr 2026 12:00:00 GMT

New feature (2026-03-21). transaction history filtering by status and type: Transaction history endpoint now supports filtering by 'status' (draft, completed, rejected, cancelled, expired) and 'transactionType' (credit or debit); 'offset' now represents page number instead of record skip.

Loyalty API

Sun, 05 Apr 2026 12:00:00 GMT

New feature (2026-02-27). new endpoint and rate limits: New DELETE endpoint to remove contacts from loyalty programs; rate limits now documented across account tiers.

Brevo MCP server — security and configuration update

Sat, 04 Apr 2026 12:00:00 GMT

Breaking (2026-03-02). Breaking change: MCP tokens now transmitted via Authorization header instead of URL; authentication method changed and 193 tools auto-generated from OpenAPI spec.

Order products fields exposure

Sat, 04 Apr 2026 12:00:00 GMT

Bug fix (2026-03-12). Full set of product fields now exposed in Order responses: `price`, `productId`, `variantId`, `quantity`, `quantityFloat`.

SDK type corrections for campaign stats and orders

Sat, 04 Apr 2026 12:00:00 GMT

Bug fix (2026-03-12). Fixed appleMppOpens and opensRate to nullable types; exposed full product fields (price, productId, variantId, quantity, quantityFloat) on orders across all SDKs.

Conversations webhooks field corrections

Thu, 02 Apr 2026 12:00:00 GMT

Breaking (2026-02-13). Renamed imageInfo.previewUrl to imageInfo.previewLink and updated preview URL quality parameter from 'lighter' to 'better'.

Batch event creation endpoint

Wed, 01 Apr 2026 12:00:00 GMT

New feature (2026-03-03). Added POST /events/batch endpoint allowing multiple events per request with partial success support (207 status) and per-event error messages.

Node.js SDK v5.0.1

Wed, 01 Apr 2026 12:00:00 GMT

Bug fix (2026-03-12). transactionalSms deprecation: sendTransacSms() deprecated in favor of sendTransacSmsAsync() to reduce latency.

Node.js SDK v5.0.3

Wed, 01 Apr 2026 12:00:00 GMT

New feature (2026-03-25). balance filters: Balance endpoints now support includeInternal parameter and transaction history supports status and transactionType filters.

PHP SDK v4.0.11

Wed, 01 Apr 2026 12:00:00 GMT

New feature (2026-03-25). createContact fix: Fixed BrevoException on empty success responses from createContact().

Python SDK v4.0.7

Wed, 01 Apr 2026 12:00:00 GMT

Bug fix (2026-03-12). transactionalSms deprecation: send_transac_sms() deprecated in favor of send_transac_sms_async().

Conversations webhooks

Tue, 31 Mar 2026 12:00:00 GMT

New feature (2026-02-13). New fields and corrections: Added rawUnsafeHtml, subject, isSentViaJsApi, sourceMessageId, email fields, isForward to Message; added mimeType, isInline, inlineId to Attachment; added isBanned to Visitor; renamed imageInfo.previewUrl to previewLink.

Node.js SDK beta release

Tue, 31 Mar 2026 12:00:00 GMT

New feature (2026-02-11). Released Node.js SDK v4.0.1 beta with promise-based API, enhanced TypeScript types, standardized error handling, and improved retry logic.

PHP SDK v4 release

Tue, 31 Mar 2026 12:00:00 GMT

New feature (2026-02-27). New PHP SDK v4 with unified Brevo client, strongly typed objects, PSR-18 HTTP client support, automatic retries, and structured error handling.

PHP SDK v4.0.10

Tue, 31 Mar 2026 12:00:00 GMT

Bug fix (2026-03-12). Deprecated sendTransacSms() method: sendTransacSms() deprecated in favor of sendAsyncTransactionalSms().

Python SDK v4 beta release

Tue, 31 Mar 2026 12:00:00 GMT

New feature (2026-02-23). Beta release of Python SDK v4.0 with native async support, Pydantic-based typed models, automatic retries with exponential backoff, and custom httpx client support.

SDK updates

Tue, 31 Mar 2026 12:00:00 GMT

Bug fix (2026-03-12). Node.js v5.0.1, PHP v4.0.10, Python v4.0.7: Type corrections for nullable fields, Order product fields exposure, deprecation of synchronous sendTransacSms() in favor of async variant, and contact creation error handling fixes.

Batch events partial success status renamed

Mon, 30 Mar 2026 12:00:00 GMT

Breaking (2026-03-21). The `status` field in `207` partial success response renamed from `partialSuccess` to `partiallyQueued` in `POST /events/batch`.

Brevo MCP server authentication method changed

Mon, 30 Mar 2026 12:00:00 GMT

Breaking (2026-03-02). Breaking change: MCP tokens moved from URL paths to HTTP `Authorization: Bearer ` header; all URL-based token patterns are no longer valid.

Conversations webhooks documentation update

Mon, 30 Mar 2026 12:00:00 GMT

Other (2026-02-13). Added new fields to Message, Attachment, and Visitor objects; renamed imageInfo.previewUrl to imageInfo.previewLink.

Events API

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-03-21). new GET endpoint: Added GET /events endpoint to retrieve events filtered by contact, name, object type, or date range with pagination.

Events API

Mon, 30 Mar 2026 12:00:00 GMT

Breaking (2026-03-21). Batch events breaking changes (response code and status field rename): POST /events/batch response code changed from 204 to 202 Accepted with JSON body; status field 'partialSuccess' renamed to 'partiallyQueued' in 207 responses - requires client code updates.

Loyalty API

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-03-21). internal balance definitions and transaction filters: Balance definitions and tier groups now support meta.isInternal flag; transaction history endpoint adds status and transactionType filters; offset parameter now represents page number instead of record skip count.

Loyalty API

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-03-21). Transaction list filters: Transaction history endpoint now supports status and transactionType filters; offset parameter changed to represent page number instead of record skip count.

Loyalty API

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-02-27). new endpoint and rate limits: New DELETE /loyalty/config/programs/{pid}/contact/{cid} endpoint removes contact from loyalty program; documented rate limits added for all account tiers.

Loyalty API guides documentation

Mon, 30 Mar 2026 12:00:00 GMT

Other (2026-03-04). Added comprehensive six-page Loyalty section covering program setup, member enrollment, transactions, and best practices.

Loyalty API rate limits documented

Mon, 30 Mar 2026 12:00:00 GMT

Other (2026-02-27). Loyalty endpoints now have documented rate limits: 600 RPH (Starter), 1,200 RPH (Business), 3,600 RPH (Enterprise).

MCP server auto-generated tools and rate limiting

Mon, 30 Mar 2026 12:00:00 GMT

Other (2026-03-02). MCP tools now auto-generated from OpenAPI spec eliminating discrepancies; rate limiting added for abuse protection; support expanded for Windsurf, VS Code Copilot, and Claude Code CLI.

Product fields

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-03-21). brand and description: Added `brand` (128 chars) and `description` (3000 chars) fields to products endpoints; updated `metaInfo` limit from 1000 KB to 20,000 characters.

SDK updates

Mon, 30 Mar 2026 12:00:00 GMT

New feature (2026-03-25). Node.js v5.0.3, PHP v4.0.11, Python v4.0.9: Multiple SDK releases adding new endpoints (getEvents, createBatchEvents, deleteAnAttribute), new product fields (brand, description), balance API enhancements (includeInternal parameter, transaction filtering), and type improvements across all three SDKs.

Transactional SMS synchronous method deprecated

Mon, 30 Mar 2026 12:00:00 GMT

Deprecation (2026-03-12). Deprecated sendTransacSms() and transactional_sms.send_transac_sms() methods; use async variants instead.