Brevo integration

Receives a real-time notification whenever a contact's details are updated in Brevo.

Receives a real-time notification whenever a recipient opens a marketing email.

Receives a real-time notification whenever a recipient clicks a link inside a marketing email.

Receives a real-time notification whenever a marketing email successfully lands in a recipient's inbox.

Receives a real-time notification whenever an email results in a Hard Bounce or Soft Bounce.

Receives a real-time notification whenever a recipient marks your marketing email as spam.

Receives a real-time notification whenever a recipient unsubscribes from a marketing campaign.

Receives a real-time notification whenever a contact is deleted from Brevo.

Receives a real-time notification whenever a contact is added to one or more lists.

Receives a real-time notification whenever a transactional email has been requested and sent by Brevo.

Receives a real-time notification whenever a transactional email successfully lands in a recipient's inbox.

Receives a real-time notification whenever a recipient opens a transactional email.

Receives a real-time notification whenever a recipient clicks a link inside a transactional email.

Receives a real-time notification whenever a transactional email results in a Hard Bounce or Soft Bounce.

Receives a real-time notification whenever a recipient marks your transactional email as spam.

Receives a real-time notification whenever a recipient unsubscribes via a transactional email link.

Receives a real-time notification whenever a recipient opens a transactional email through an email client proxy (like Apple Mail Privacy Protection or Google Image Proxy).

Receives a real-time notification the very first time a transactional email is opened by a recipient via a proxy client.

Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies.

Update an existing deal's attributes, name, linked contacts, or linked companies. Note that passing linked lists REPLACES the entire list of associations.

Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, and linked entities.

Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission.

Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals.

Update an existing company's attributes, name, linked contacts, or linked deals. Note that passing linked lists REPLACES the entire list of associations.

Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals.

Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities.

Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission.

Retrieves aggregated statistics per day for the past 10 days by default. The date range cannot exceed 30 days.

Retrieves unaggregated email events for the past 30 days by default. The date range cannot exceed 90 days.

Retrieves aggregated statistics for the past 90 days by default. The date range cannot exceed 90 days.

Retrieve a paginated list of all transactional email templates (including automation templates) with their details.

Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted.

Generate a fully rendered preview of a transactional email template by resolving dynamic variables.

Sends an asynchronous transactional or marketing SMS. If a stop code is included, it is automatically treated as marketing.

Sends a WhatsApp message to one or more contact numbers. Note: The first message you send to a contact must use a Template ID.

Retrieves unaggregated statistics for WhatsApp activity for the past 30 days by default. The date range cannot exceed 90 days.

Retrieves a paginated list of all created email campaigns. You must specify which type of statistics you would like to retrieve.

Creates an email campaign. You must specify the sender, the campaign name, and either HTML content, an HTML URL, or a Template ID.

Update an existing email campaign's properties. Only draft or scheduled campaigns can be modified.

Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted.

Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content.

Send a test version of an email campaign to specified email addresses or your entire test list.

Update the status of an email campaign, such as suspending, archiving, or replicating it.

Generates a unique URL for the email campaign or transactional template to share with other Brevo users.

Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type.

Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information.

Create a new SMS campaign with the required name, sender, and content fields.

Retrieve detailed information about a specific SMS campaign by its ID, including content, sender, recipients, and statistics.

Update an existing SMS campaign's properties such as name, sender, content, recipients, scheduled date, etc.

Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted.

Send an existing SMS campaign immediately by scheduling it for the current time.

Update the status of an SMS campaign, such as suspending, archiving, or replicating it.

Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients.

Export the recipients of a sent SMS campaign as an asynchronous process.

Send a report of a Sent or Archived campaign to specified email addresses, with a PDF attachment in detail.

Retrieve detailed information about a specific WhatsApp campaign by its ID, including recipients, template details, and statistics.

Delete a WhatsApp campaign by its campaign ID. This action is permanent and cannot be undone.

Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata.

Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata.

Creates and schedules a WhatsApp campaign. Requires an approved WhatsApp Template ID, a schedule date, and recipient lists/segments.

Update an existing WhatsApp campaign's properties such as name, status, schedule time, and recipients.

Retrieves the configuration and verification status of your WhatsApp Business API account in Brevo.

Create a new contact attribute under the specified category and name. The required body properties depend on the chosen category.

Update an existing contact attribute identified by its category and name. The required body properties depend on the chosen category.

Retrieve all contact attributes defined in your Brevo account, grouped by category.

Permanently delete an existing contact attribute by its category and name.

Delete a specific option from an existing multiple-choice contact attribute.

Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required.

Retrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics.

Retrieve a paginated listing of all the lists available in your account.

Update an existing contact list. You can update the list name, move it to a different folder by providing a new folderId, or both.

Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list.

Retrieve all contacts belonging to a specific list, identified by its list ID.

Add multiple existing contacts to a specified list using their IDs, External IDs, or Email Addresses.

Remove multiple contacts from a specified list using their IDs, External IDs, Email Addresses, or remove all contacts.

Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together.

Retrieve the details of a specific contact folder by its ID.

Update the name of an existing folder identified by its ID.

Retrieve a paginated list of all folders available in your account.

Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it.

Retrieve a paginated list of all contact lists contained within a specific folder.

Creates a new contact. Contacts can be created by passing either an email address, a phone number (via 'SMS' attribute), or an external ID.

Update an existing contact's attributes, lists, or blacklist status.

Creates a new contact and sends a Double Opt-In (DOI) confirmation email.

Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting.

Retrieve a specific contact's details and recent campaign statistics.

Permanently delete a contact using their identifier.

Retrieve email campaign statistics for a specific contact identified by email address or numeric ID.

Retrieve all contact segments defined in your Brevo account with support for pagination and sorting.

It returns a background process ID which on completion calls the notify URL. File will be available in CSV.

Import contacts using a File URL, CSV File Body, or JSON Body. Returns a background process ID.

Retrieves a list of all email senders from your Brevo account with optional filtering by IP or domain.

Creates a new email sender in your Brevo account. A verification email will be sent to the address provided.

Updates an existing email sender's configuration, such as display name, email address, or dedicated IP assignments.

Deletes an email sender from your Brevo account permanently.

Validates a newly created sender using the 6-digit OTP received via email.

Retrieves all dedicated IPs associated with your Brevo account. Returns an empty array for standard accounts without dedicated IPs.

Retrieves the dedicated IPs associated with a specific sender by Sender ID.

Get complete account information including user details, plan limits, relay configuration, and marketing automation status.

Retrieves user activity logs from your organization for security monitoring and audit compliance (Requires Enterprise plan).

Create a new custom attribute for companies or deals. The attribute label must be unique within the object type.

Retrieve the list of all attributes defined for companies, including both system-default and custom attributes.

Link or unlink contacts and deals with a specific company in a single request.

Import companies using an array of objects. Since direct file upload via multipart/form-data is restricted, pass the equivalent JSON structure into the mapping body if supported, or provide the remote file URL if your wrapper permits it.

Retrieve the details of a specific deal pipeline by its identifier, including its stages and configuration.

Retrieve the list of all deal pipelines configured for your account, including each pipeline's stages and settings.

Retrieve a paginated list of deals with optional filtering by name, owner, pipeline, stage, or linked entities.

Link or unlink contacts and companies with a specific deal in a single request.

Import deals using an array of objects. Pass the equivalent JSON structure into the mapping body, or provide the remote file URL if your wrapper permits.

Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals.

Update an existing CRM task's properties. Omitted fields remain unchanged.

Retrieve the full details of a single CRM task by its identifier.

Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders.

Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities.

Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range.

Create a new CRM note and associate it with contacts, companies, or deals. Supports HTML for rich text formatting.

Retrieve the full details of a single CRM note by its identifier.

Update an existing CRM note's text content and its associations with contacts, companies, or deals.

Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals.

Create a new order or update the transactional status of an existing order. Requires Order ID, Amount, Status, Timestamps, and at least one Product.

Retrieve a paginated list of all eCommerce orders. You can filter by creation or modification dates.

Create multiple orders simultaneously. Configure the primary order using individual fields, and/or provide additional orders via the stringified array.

Create a new ecommerce product or update an existing one. If updateEnabled is true, an upsert is performed.

Retrieve the full details of a single ecommerce product by its unique ID.

Create or update up to 100 products in a single request. Provide a valid stringified JSON array.

Retrieve a paginated list of all ecommerce products. Filter by name, SKU, category, or price range.

Register a contact to receive an alert for a specific product event (like back_in_stock).

Create a new payment request for a Brevo contact. Requires a reference, contact ID, and amount in cents.

Retrieve the details of a specific payment request by its ID. Includes the status, cart details, and notification configuration.

Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid.

Create a new subscription to a specific loyalty program for a contact in Brevo. Requires the Loyalty Program ID and the Contact ID.

Create a new transaction for a loyalty program balance. A positive amount creates a credit; a negative amount creates a debit.

Completes a drafted transaction in a loyalty program.

Cancels a drafted transaction in a loyalty program.