Changelog

Email Campaigns — UTM parameter customization

You can now customize UTM tracking parameters for email campaigns. When creating or updating a campaign, pass optional utmCampaign, utmContent, and utmTerm fields to override default values that appear in outgoing tracking links.

Request fields (optional):

• utmCampaign — Customize the utm_campaign value. If empty, the campaign name is used. Only alphanumeric characters and spaces are allowed.
• utmContent — Customize the utm_content value. Appears on outgoing tracking links alongside utm_campaign.
• utmTerm — Customize the utm_term value. Appears on outgoing tracking links alongside utm_campaign.

Response fields (when retrieving campaigns):

• utmCampaignValue — The utm_campaign value associated with the campaign. Only present if set.
• utmContent — The utm_content value. Only present if set.
• utmTerm — The utm_term value. Only present if set.
• utmID — The campaign ID used as utm_id parameter. Only present if UTM campaign tracking with ID is enabled.
• utmMedium — The utm_medium value. Set to “EMAIL” when UTM campaign tracking is enabled.
• utmSource — The utm_source value. Set to “Brevo” when UTM campaign tracking is enabled.

Endpoints updated:

• Create an email campaign — POST /emailCampaigns
• Update an email campaign — PUT /emailCampaigns/{campaignId}
• Get email campaigns — GET /emailCampaigns
• Get an email campaign — GET /emailCampaigns/{campaignId}

All new fields are optional and backwards compatible — existing integrations continue to work without changes.

Transactional Email — per-contact pixel tracking consent

You can now specify open tracking consent per recipient when sending transactional emails. The contactPixelTrackingConsent field controls whether recipient opens are tracked identifiably or anonymized.

How it works:

• contactPixelTrackingConsent: true — recipient has consented; the open pixel identifies them and the event is attributed to their email address
• contactPixelTrackingConsent: false — open event is anonymized and counted only in aggregate statistics

When the feature is enabled for your account, set true or false per recipient to control open tracking. If the field is not passed, the recipient is treated as unknown consent status and the email is still sent — the open is anonymized unless your account is configured to track unknown-consent contacts. A value other than true/false is rejected. When the feature is not enabled for your account, the field is ignored.

Available on all recipient types:

The field can be set on any recipient in the to, cc, bcc, and messageVersions arrays.

Endpoint updated:

Send a transactional email — POST /smtp/email