Brevo MCP connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'brevomcp'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Brevo MCP:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'brevomcp_accounts_get_corporate_invited_users_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "brevomcp"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Brevo MCP:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="brevomcp_accounts_get_corporate_invited_users_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• Send whatsapp management, whatsapp campaigns, transac templates — Send a WhatsApp message to one or more contacts
• Get whatsapp management, whatsapp campaigns — Retrieve a paginated list of individual WhatsApp event records (unaggregated), including event type, contact number, sender number, message ID, timestamp, and contextual fields like body text, media URL, and error reason where applicable
• Create whatsapp management, whatsapp campaigns, webhooks management — Create a new WhatsApp message template with the specified name, language, category, and body text
• Update whatsapp campaigns, webhooks management, templates — Update an existing WhatsApp campaign’s name, status, recipients, or scheduled sending time
• Delete whatsapp campaigns, webhooks management, transac templates — Delete a WhatsApp campaign by its campaign ID
• History webhooks management export webhooks — Exports webhook event history to CSV format for analysis and reporting

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

brevomcp_accounts_delete_corporate_sub_account_by_id#Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.1 param▾

Permanently deletes a sub-account from the corporate master account. Once deleted, all data associated with the sub-account organization is removed and cannot be recovered, so ensure the sub-account is no longer needed before proceeding.

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization to be deleted

brevomcp_accounts_delete_corporate_user_revoke_by_email#Revokes access for an invited admin user on the corporate master account. Once revoked, the user will no longer be able to access the admin account or manage any sub-accounts. This action is permanent and the user would need to be re-invited to regain access.1 param▾

Revokes access for an invited admin user on the corporate master account. Once revoked, the user will no longer be able to access the admin account or manage any sub-accounts. This action is permanent and the user would need to be re-invited to regain access.

NameTypeRequiredDescription

emailstringrequiredEmail of the invited user

brevomcp_accounts_get_account#Retrieves details of your Brevo account.0 params▾

Retrieves details of your Brevo account.

brevomcp_accounts_get_account_activity#Retrieves user activity logs from your organization for security monitoring and audit compliance.5 params▾

Retrieves user activity logs from your organization for security monitoring and audit compliance.

NameTypeRequiredDescription

emailstringoptionalEnter the user's email address to filter their activity in the account.

endDatestringoptionalMandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document in the page.

startDatestringoptionalMandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.

brevomcp_accounts_get_corporate_invited_users_list#This endpoint allows you to list all Admin users of your Admin account. You can filter users by type (active or pending) and paginate results using offset and limit.3 params▾

This endpoint allows you to list all Admin users of your Admin account. You can filter users by type (active or pending) and paginate results using offset and limit.

NameTypeRequiredDescription

limitstringoptionalNumber of users to be displayed on each page. This is optional, the default limit is 20, but max allowed limit is 100.

offsetstringoptionalPage number for the result set. This is optional, default value will be the 1st page.

typestringoptionalUser type (active | pending). This is required if offset is provided for limited result.

brevomcp_accounts_get_corporate_ip#Retrieves the list of all active dedicated IPs available on the corporate admin account. Each IP entry includes the IP address, associated domain, and whether it is configured for transactional email sending.0 params▾

Retrieves the list of all active dedicated IPs available on the corporate admin account. Each IP entry includes the IP address, associated domain, and whether it is configured for transactional email sending.

brevomcp_accounts_get_corporate_master_account#Retrieves comprehensive details of the corporate master account, including company information, billing details, current plan configuration with feature quotas, and timezone settings. This endpoint is only accessible by the master account owner.0 params▾

Retrieves comprehensive details of the corporate master account, including company information, billing details, current plan configuration with feature quotas, and timezone settings. This endpoint is only accessible by the master account owner.

brevomcp_accounts_get_corporate_sub_account#Retrieves a paginated list of all sub-accounts under the corporate master account. Each sub-account entry includes company name, creation date, active status, and group memberships. Use `offset` and `limit` parameters for pagination.2 params▾

Retrieves a paginated list of all sub-accounts under the corporate master account. Each sub-account entry includes company name, creation date, active status, and group memberships. Use `offset` and `limit` parameters for pagination.

NameTypeRequiredDescription

limitintegerrequiredNumber of sub-accounts to be displayed on each page

offsetintegerrequiredIndex of the first sub-account in the page

brevomcp_accounts_get_corporate_sub_account_by_id#Retrieves detailed information about a specific sub-account including company name, contact email, group memberships, and comprehensive plan details with credit quotas and feature allocations.1 param▾

Retrieves detailed information about a specific sub-account including company name, contact email, group memberships, and comprehensive plan details with credit quotas and feature allocations.

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization

brevomcp_accounts_get_corporate_user_permission#Retrieves the granular feature-level permissions assigned to a specific admin user, identified by their email address. The response includes the user's current status (active or pending), the groups they belong to, and a detailed breakdown of feature access permissions.1 param▾

Retrieves the granular feature-level permissions assigned to a specific admin user, identified by their email address. The response includes the user's current status (active or pending), the groups they belong to, and a detailed breakdown of feature access permissions.

NameTypeRequiredDescription

emailstringrequiredEmail of the invited user.

brevomcp_accounts_invite_admin_user#Invites a new member to manage the Admin (master) account by sending an invitation email.4 params▾

Invites a new member to manage the Admin (master) account by sending an invitation email.

NameTypeRequiredDescription

all_features_accessstringrequiredAll access to the features

emailstringrequiredEmail address for the organization

privilegesstringrequiredNo description.

groupIdsstringoptionalIds of Group

brevomcp_accounts_post_corporate_sso_token#Generates a Single Sign-On (SSO) token that allows authentication to the corporate admin account without requiring a separate login. The generated token is valid for 15 days and can be used via the URL https://account-app.brevo.com/account/login/corporate/sso/[token].1 param▾

Generates a Single Sign-On (SSO) token that allows authentication to the corporate admin account without requiring a separate login. The generated token is valid for 15 days and can be used via the URL https://account-app.brevo.com/account/login/corporate/sso/[token].

NameTypeRequiredDescription

emailstringrequiredUser email of admin account

brevomcp_accounts_post_corporate_sub_account#Creates a new sub-account under the corporate master account. The sub-account will be provisioned with the specified company name and email address. Optionally, you can assign the sub-account to one or more groups and set language and timezone preferences.5 params▾

Creates a new sub-account under the corporate master account. The sub-account will be provisioned with the specified company name and email address. Optionally, you can assign the sub-account to one or more groups and set language and timezone preferences.

NameTypeRequiredDescription

companyNamestringrequiredSet the name of the sub-account company

emailstringrequiredEmail address for the organization

groupIdsstringoptionalSet the group(s) for the sub-account

languagestringoptionalSet the language of the sub-account

timezonestringoptionalSet the timezone of the sub-account

brevomcp_accounts_post_corporate_sub_account_ip_associate#Associates a dedicated IP address with one or more sub-account organizations. This allows the specified sub-accounts to use the dedicated IP for sending emails. Both the IP address and a list of sub-account IDs are required.2 params▾

Associates a dedicated IP address with one or more sub-account organizations. This allows the specified sub-accounts to use the dedicated IP for sending emails. Both the IP address and a list of sub-account IDs are required.

NameTypeRequiredDescription

idsstringrequiredPass the list of sub-account Ids to be associated with the IP address

ipstringrequiredIP address

brevomcp_accounts_post_corporate_sub_account_key#Generates a new API v3 key for a specific sub-account organization. Both the sub-account ID and a name for the API key are required. The generated key is returned in the response and should be stored securely, as it cannot be retrieved again after creation.2 params▾

Generates a new API v3 key for a specific sub-account organization. Both the sub-account ID and a name for the API key are required. The generated key is returned in the response and should be stored securely, as it cannot be retrieved again after creation.

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization

namestringrequiredName of the API key

brevomcp_accounts_post_corporate_sub_account_sso_token#Generates a Single Sign-On (SSO) token that allows the master account to authenticate directly into a sub-account without requiring separate login credentials. The generated token is valid for 15 days and can be used via the URL https://account-app.brevo.com/account/login/sub-account/sso/[token].4 params▾

Generates a Single Sign-On (SSO) token that allows the master account to authenticate directly into a sub-account without requiring separate login credentials. The generated token is valid for 15 days and can be used via the URL https://account-app.brevo.com/account/login/sub-account/sso/[token].

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization

emailstringoptionalUser email of sub-account organization

targetstringoptionalSet target after login success * automation - Redirect to Automation after login * email_campaign - Redirect to Email Campaign after login * contacts - Redirect to Contacts after login * landing_pages - Redirect to Landing Pages after login * email_transactional - Redirect to Email Transactional after login * senders - Redirect to Senders after login * sms_campaign - Redirect to Sms Campaign after login * sms_transactional - Redirect to Sms Transactional after login

urlstringoptionalSet the full target URL after login success. The user will land directly on this target URL after login

brevomcp_accounts_put_corporate_sub_account_applications_toggle#Enables or disables specific applications for a sub-account organization. Each application can be toggled independently using boolean values.14 params▾

Enables or disables specific applications for a sub-account organization. Each application can be toggled independently using boolean values.

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization (mandatory)

automationstringoptionalSet this field to enable or disable Automation on the sub-account

conversationsstringoptionalSet this field to enable or disable Conversations on the sub-account

crmstringoptionalSet this field to enable or disable Sales CRM on the sub-account

email_campaignsstringoptionalSet this field to enable or disable Email Campaigns on the sub-account

facebook_adsstringoptionalSet this field to enable or disable Facebook ads on the sub-account

inboxstringoptionalSet this field to enable or disable Inbox on the sub-account / Not applicable on ENTv2

landing_pagesstringoptionalSet this field to enable or disable Landing pages on the sub-account

meetingsstringoptionalSet this field to enable or disable Meetings on the sub-account

sms_campaignsstringoptionalSet this field to enable or disable SMS Marketing on the sub-account

transactional_emailsstringoptionalSet this field to enable or disable Transactional Email on the sub-account

transactional_smsstringoptionalSet this field to enable or disable Transactional SMS on the sub-account

web_pushstringoptionalSet this field to enable or disable Web Push on the sub-account

whatsappstringoptionalSet this field to enable or disable Whatsapp campaigns on the sub-account

brevomcp_accounts_put_corporate_sub_account_ip_dissociate#Removes the association of a dedicated IP address from one or more sub-account organizations. After dissociation, the specified sub-accounts will no longer be able to use this dedicated IP for sending emails. Both the IP address and a list of sub-account IDs are required.2 params▾

Removes the association of a dedicated IP address from one or more sub-account organizations. After dissociation, the specified sub-accounts will no longer be able to use this dedicated IP for sending emails. Both the IP address and a list of sub-account IDs are required.

NameTypeRequiredDescription

idsstringrequiredPass the list of sub-account Ids to be dissociated from the IP address

ipstringrequiredIP address

brevomcp_accounts_put_corporate_sub_account_plan#Updates the plan configuration for a specific sub-account, including credit allocations (email, SMS, WhatsApp, push) and feature quotas (users, landing pages, inbox, sales users). On Corporate solution v2 (ENTv2), you can set unlimited credits by passing -1 as the value.3 params▾

Updates the plan configuration for a specific sub-account, including credit allocations (email, SMS, WhatsApp, push) and feature quotas (users, landing pages, inbox, sales users). On Corporate solution v2 (ENTv2), you can set unlimited credits by passing -1 as the value.

NameTypeRequiredDescription

idintegerrequiredId of the sub-account organization

creditsstringoptionalCredit details to update

featuresstringoptionalFeatures details to update

brevomcp_accounts_put_corporate_sub_accounts_plan#Updates the plan configuration for multiple sub-accounts at once with the same credit allocations and feature quotas. This is useful for applying consistent plan settings across a batch of sub-accounts. On Corporate solution v2 (ENTv2), you can set unlimited credits by passing -1.3 params▾

Updates the plan configuration for multiple sub-accounts at once with the same credit allocations and feature quotas. This is useful for applying consistent plan settings across a batch of sub-accounts. On Corporate solution v2 (ENTv2), you can set unlimited credits by passing -1.

NameTypeRequiredDescription

creditsstringoptionalCredit details to update

featuresstringoptionalFeatures details to update

subAccountIdsstringoptionalList of sub-account ids

brevomcp_accounts_put_corporate_user_invitation_by_email#Allows you to resend or cancel a pending invitation for an admin user. Use the `resend` action to send a new invitation email to the recipient, or the `cancel` action to revoke the pending invitation entirely. The action is specified as a path parameter and must be either `resend` or `cancel`.2 params▾

Allows you to resend or cancel a pending invitation for an admin user. Use the `resend` action to send a new invitation email to the recipient, or the `cancel` action to revoke the pending invitation entirely. The action is specified as a path parameter and must be either `resend` or `cancel`.

NameTypeRequiredDescription

actionstringrequiredAction to be performed (cancel / resend)

emailstringrequiredEmail address of the recipient

brevomcp_accounts_put_corporate_user_permissions#Updates the feature-level permissions for an existing admin user of your master account, identified by their email address. If `all_features_access` is set to `true`, the user receives full permissions on all features and the `privileges` array is ignored.3 params▾

Updates the feature-level permissions for an existing admin user of your master account, identified by their email address. If `all_features_access` is set to `true`, the user receives full permissions on all features and the `privileges` array is ignored.

NameTypeRequiredDescription

all_features_accessstringrequiredAll access to the features

emailstringrequiredEmail address of Admin user

privilegesstringrequiredNo description.

brevomcp_attributes_create_attribute#Create a new contact attribute under the specified category and name.7 params▾

Create a new contact attribute under the specified category and name.

NameTypeRequiredDescription

attributeCategorystringrequiredCategory of the attribute

attributeNamestringrequiredName of the attribute

enumerationstringoptionalList of values and labels that the attribute can take. Use only if the attribute's category is "category". None of the category options can exceed max 200 characters. For example: [{"value":1, "label":"male"}, {"value":2, "label":"female"}]

isRecurringstringoptionalType of the attribute. Use only if the attribute's category is 'calculated' or 'global'

multiCategoryOptionsstringoptionalList of options you want to add for multiple-choice attribute. Use only if the attribute's category is "normal" and attribute's type is "multiple-choice". None of the multicategory options can exceed max 200 characters. For example: ["USA","INDIA"]

typestringoptionalType of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' Type user and multiple-choice is only available if the category is normal attribute Type id is only available if the category is transactional attribute Type category is only available if the category is category attribute

valuestringoptionalValue of the attribute. Use only if the attribute's category is 'calculated' or 'global'

brevomcp_attributes_delete_attribute#Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.2 params▾

Permanently delete an existing contact attribute by its category and name. The attribute must exist in the specified category (normal, transactional, category, calculated, or global), otherwise a 404 error is returned.

NameTypeRequiredDescription

attributeCategorystringrequiredCategory of the attribute

attributeNamestringrequiredName of the existing attribute

brevomcp_attributes_delete_crm_attributes_by_id#Delete an existing custom attribute by its identifier. This permanently removes the attribute definition and cleans up all references to it across companies or deals. System-default and non-editable attributes cannot be deleted.1 param▾

Delete an existing custom attribute by its identifier. This permanently removes the attribute definition and cleans up all references to it across companies or deals. System-default and non-editable attributes cannot be deleted.

NameTypeRequiredDescription

idstringrequiredAttribute ID

brevomcp_attributes_delete_multi_attribute_options#Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.3 params▾

Delete a specific option from an existing multiple-choice contact attribute. The attribute type must be "multiple-choice", and both the attribute name and the option to delete must already exist in your account.

NameTypeRequiredDescription

attributeTypestringrequiredType of the attribute

multipleChoiceAttributestringrequiredName of the existing multiple-choice attribute

multipleChoiceAttributeOptionstringrequiredName of the existing multiple-choice attribute option that you want to delete

brevomcp_attributes_get_attributes#Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.0 params▾

Retrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global). Each attribute includes its name, type, and category, along with enumeration values for category-type attributes and options for multiple-choice-type attributes.

brevomcp_attributes_get_crm_attributes_companies#Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, and available options for select-type attributes.0 params▾

Retrieve the list of all attributes defined for companies, including both system-default and custom attributes. Each attribute includes its label, internal name, type, and available options for select-type attributes.

brevomcp_attributes_get_crm_attributes_deals#Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.0 params▾

Retrieve the list of all attributes defined for deals, including both system-default and custom attributes. Each attribute includes its label, internal name, type, required status, and available options for select-type attributes.

brevomcp_attributes_patch_crm_attributes_by_id#Update an existing custom attribute's label or options. You can rename the attribute label or modify the available options for `single-select` and `multi-choice` attribute types. System-default attributes cannot be modified except for specific editable fields.4 params▾

Update an existing custom attribute's label or options. You can rename the attribute label or modify the available options for `single-select` and `multi-choice` attribute types. System-default attributes cannot be modified except for specific editable fields.

NameTypeRequiredDescription

idstringrequiredAttribute ID

labelstringoptionalAttribute display label (max 50 characters)

objectTypestringoptionalThe type of object the attribute belongs to, it cannot be updated after creation

optionsLabelsstringoptionalUpdated labels for selectable options

brevomcp_attributes_post_crm_attributes#Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For `single-select` or `multi-choice` attribute types, you must also provide the `optionsLabels` array.5 params▾

Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For `single-select` or `multi-choice` attribute types, you must also provide the `optionsLabels` array.

NameTypeRequiredDescription

attributeTypestringrequiredThe type of attribute (must be one of the defined enums)

labelstringrequiredThe label for the attribute (max 50 characters, cannot be empty)

objectTypestringrequiredThe type of object the attribute belongs to. Must be either `companies` or `deals`.

descriptionstringoptionalA description of the attribute

optionsLabelsstringoptionalOptions for multi-choice or single-select attributes

brevomcp_attributes_update_attribute#Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options.5 params▾

Update an existing contact attribute identified by its category and name. For category-type attributes, you can update the enumeration values; for calculated or global attributes, update the computed value formula; and for normal multiple-choice attributes, update the multicategory options.

NameTypeRequiredDescription

attributeCategorystringrequiredCategory of the attribute

attributeNamestringrequiredName of the existing attribute

enumerationstringoptionalList of the values and labels that the attribute can take. Use only if the attribute's category is "category" None of the category options can exceed max 200 characters. For example, [{"value":1, "label":"male"}, {"value":2, "label":"female"}]

multiCategoryOptionsstringoptionalUse this option to add multiple-choice attributes options only if the attribute's category is "normal". This option is specifically designed for updating multiple-choice attributes. None of the multicategory options can exceed max 200 characters.. For example: ["USA","INDIA"]

valuestringoptionalValue of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'

brevomcp_campaign_analytics_get_ab_test_campaign_result#Retrieve the results of an A/B test email campaign, including the winning version, open and click rates, and per-version statistics. The campaign must have A/B testing enabled; if the campaign is still in draft and has not been scheduled, an empty response is returned.1 param▾

Retrieve the results of an A/B test email campaign, including the winning version, open and click rates, and per-version statistics. The campaign must have A/B testing enabled; if the campaign is still in draft and has not been scheduled, an empty response is returned.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the A/B test campaign

brevomcp_campaign_analytics_get_aggregated_smtp_report#Retrieve aggregated transactional email statistics (requests, delivered, opens, clicks, bounces, spam reports, blocked, invalid, unsubscribed) for a specified time period.4 params▾

Retrieve aggregated transactional email statistics (requests, delivered, opens, clicks, bounces, spam reports, blocked, invalid, unsubscribed) for a specified time period.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided.

endDatestringoptionalMandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

startDatestringoptionalMandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

tagstringoptionalTag of the emails

brevomcp_campaign_analytics_get_email_event_report#Retrieve a paginated list of individual transactional email event records (unaggregated), including event type, recipient email, sender, message ID, subject, timestamp, tag, template ID, and contextual fields like IP address, link, and bounce reason where applicable.11 params▾

Retrieve a paginated list of individual transactional email event records (unaggregated), including event type, recipient email, sender, message ID, subject, timestamp, tag, template ID, and contextual fields like IP address, link, and bounce reason where applicable.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided.

emailstringoptionalFilter the report for a specific email addresses

endDatestringoptionalMandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

eventstringoptionalFilter the report for a specific event type

limitstringoptionalNumber limitation for the result returned

messageIdstringoptionalFilter on a specific message id

offsetstringoptionalBeginning point in the list to retrieve from.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

tagsstringoptionalFilter the report for tags (serialized and urlencoded array)

templateIdstringoptionalFilter on a specific template id

brevomcp_campaign_analytics_get_smtp_report#Retrieve a day-by-day breakdown of transactional email statistics (requests, delivered, opens, unique opens, clicks, unique clicks, hard bounces, soft bounces, spam reports, blocked, invalid, unsubscribed) for a specified time period.7 params▾

Retrieve a day-by-day breakdown of transactional email statistics (requests, delivered, opens, unique opens, clicks, unique clicks, hard bounces, soft bounces, spam reports, blocked, invalid, unsubscribed) for a specified time period.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_

endDatestringoptionalMandatory if startDate is used. Ending date of the report (YYYY-MM-DD)

limitstringoptionalNumber of documents returned per page

offsetstringoptionalIndex of the first document on the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date of the report (YYYY-MM-DD)

tagstringoptionalTag of the emails

brevomcp_categories_create_update_batch_category#Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned.2 params▾

Create or update multiple ecommerce categories in a single request. The `categories` array accepts up to 100 category objects, each requiring a unique `id`. When `updateEnabled` is `false` (the default), all categories are inserted as new; if any ID already exists, a `400` error is returned.

NameTypeRequiredDescription

categoriesstringrequiredarray of categories objects

updateEnabledstringoptionalFacilitate to update the existing categories in the same request (updateEnabled = true)

brevomcp_categories_create_update_category#Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned.6 params▾

Create a new ecommerce category or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is set to `false` (the default), the endpoint performs an insert and returns `201`; if the category ID already exists, a `400` error is returned.

NameTypeRequiredDescription

idstringrequiredUnique Category ID as saved in the shop

deletedAtstringoptionalUTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database

isDeletedstringoptionalcategory deleted from the shop's database

namestringoptionalMandatory in case of creation. Name of the Category, as displayed in the shop

updateEnabledstringoptionalFacilitate to update the existing category in the same request (updateEnabled = true)

urlstringoptionalURL to the category

brevomcp_categories_get_categories#Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status.8 params▾

Retrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status.

NameTypeRequiredDescription

createdSincestringoptionalFilter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

idsstringoptionalFilter by category ids

isDeletedstringoptionalFilter categories by their deletion status. If `false` is passed, only categories that are not deleted will be returned.

limitstringoptionalNumber of documents per page

modifiedSincestringoptionalFilter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

namestringoptionalFilter by category name

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_categories_get_category_info#Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.1 param▾

Retrieve the full details of a single ecommerce category by its unique ID. The response includes the category name, URL, creation and modification timestamps, and deletion status. Returns a `404` error if no category matches the provided ID.

NameTypeRequiredDescription

idstringrequiredCategory ID

brevomcp_companies_delete_by_id#Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission on companies; otherwise, a 403 Forbidden error is returned.1 param▾

Permanently delete a company by its identifier. The requesting user must be the company owner or have manage permission on companies; otherwise, a 403 Forbidden error is returned.

NameTypeRequiredDescription

idstringrequiredCompany ID to delete

brevomcp_companies_get_by_id#Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.1 param▾

Retrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals. Returns a 404 error if the company does not exist, or a 403 error if the user lacks permission to view the company.

NameTypeRequiredDescription

idstringrequiredGet Company Details

brevomcp_companies_get_companies#Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default with a default page of 1 and limit of 50.9 params▾

Retrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default with a default page of 1 and limit of 50.

NameTypeRequiredDescription

createdSincestringoptionalFilter (urlencoded) the companies created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

filters_attributes_namestringoptionalFilter by attributes. If you have a filter for the owner on your side please send it as filters[attributes.owner] and utilize the account email for the filtering.

limitstringoptionalNumber of documents per page

linkedContactsIdsstringoptionalFilter by linked contacts ids

linkedDealsIdsstringoptionalFilter by linked Deals ids

modifiedSincestringoptionalFilter (urlencoded) the companies modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

pagestringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

sortBystringoptionalThe field used to sort field names.

brevomcp_companies_patch_by_id#Update an existing company's attributes, name, linked contacts, or linked deals. Note that passing `linkedContactsIds` or `linkedDealsIds` replaces the entire list of associations, so omitted IDs will be removed. The company name cannot be set to an empty string.6 params▾

Update an existing company's attributes, name, linked contacts, or linked deals. Note that passing `linkedContactsIds` or `linkedDealsIds` replaces the entire list of associations, so omitted IDs will be removed. The company name cannot be set to an empty string.

NameTypeRequiredDescription

idstringrequiredNo description.

attributesstringoptionalAttributes for company update

countryCodestringoptionalCountry code if phone_number is passed in attributes.

linkedContactsIdsstringoptionalWarning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.

linkedDealsIdsstringoptionalWarning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed.

namestringoptionalName of company

brevomcp_companies_patch_link_unlink_by_id#Link or unlink contacts and deals with a specific company in a single request. You can simultaneously link new contacts/deals and unlink existing ones by providing the respective ID arrays in the request body. At least one of the four arrays must contain values.5 params▾

Link or unlink contacts and deals with a specific company in a single request. You can simultaneously link new contacts/deals and unlink existing ones by providing the respective ID arrays in the request body. At least one of the four arrays must contain values.

NameTypeRequiredDescription

idstringrequiredID of the company to link or unlink entities with

linkContactIdsstringoptionalContact IDs for contacts to be linked with the company

linkDealsIdsstringoptionalDeal IDs for deals to be linked with the company

unlinkContactIdsstringoptionalContact IDs for contacts to be unlinked from the company

unlinkDealsIdsstringoptionalDeal IDs for deals to be unlinked from the company

brevomcp_companies_post_companies#Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals. The company name is required, and you can optionally provide a country code when a phone number attribute is included.5 params▾

Create a new CRM company with the specified name, attributes, and optional associations to contacts and deals. The company name is required, and you can optionally provide a country code when a phone number attribute is included.

NameTypeRequiredDescription

namestringrequiredName of company

attributesstringoptionalAttributes for company creation

countryCodestringoptionalCountry code if phone_number is passed in attributes.

linkedContactsIdsstringoptionalContact ids to be linked with company

linkedDealsIdsstringoptionalDeal ids to be linked with company

brevomcp_companies_post_import#Import companies in bulk from a CSV file with configurable mapping options. The CSV file must have the first row as column headers matching attribute internal names.0 params▾

Import companies in bulk from a CSV file with configurable mapping options. The CSV file must have the first row as column headers matching attribute internal names.

brevomcp_contact_import_export_create_doi_contact#Create a contact using the Double Opt-In (DOI) flow. A confirmation email is sent to the provided email address using the specified DOI template. The contact is only fully created after the recipient clicks the confirmation link.6 params▾

Create a contact using the Double Opt-In (DOI) flow. A confirmation email is sent to the provided email address using the specified DOI template. The contact is only fully created after the recipient clicks the confirmation link.

NameTypeRequiredDescription

emailstringrequiredEmail address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.

includeListIdsstringrequiredLists under user account where contact should be added

redirectionUrlstringrequiredURL of the web page that user will be redirected to after clicking on the double opt in URL. When editing your DOI template you can reference this URL by using the tag {{ params.DOIurl }}.

templateIdintegerrequiredId of the Double opt-in (DOI) template

attributesstringoptionalPass the set of attributes and their values. These attributes must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger', 'COUNTRIES': ['India','China']}

excludeListIdsstringoptionalLists under user account where contact should not be added

brevomcp_contact_import_export_get_contacts_from_list#Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.5 params▾

Retrieve all contacts belonging to a specific list, identified by its list ID. Results are paginated with a default of 50 contacts per page (maximum 500) and sorted in descending order of creation. You can optionally filter contacts by their modification date using the modifiedSince parameter.

NameTypeRequiredDescription

listIdintegerrequiredId of the list

limitstringoptionalNumber of documents per page

modifiedSincestringoptionalFilter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_contact_import_export_import_contacts#Import contacts into your Brevo account from a CSV file body, a JSON body, or a remote file URL. Exactly one of fileBody, jsonBody, or fileUrl must be provided. The maximum allowed size for fileBody and jsonBody is 10 MB (8 MB recommended); for larger imports, use the fileUrl option.11 params▾

Import contacts into your Brevo account from a CSV file body, a JSON body, or a remote file URL. Exactly one of fileBody, jsonBody, or fileUrl must be provided. The maximum allowed size for fileBody and jsonBody is 10 MB (8 MB recommended); for larger imports, use the fileUrl option.

NameTypeRequiredDescription

disableNotificationstringoptionalTo disable email notification

emailBlackliststringoptionalTo blacklist all the contacts for email

emptyContactsAttributesstringoptionalTo facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true )

fileBodystringoptionalMandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.

fileUrlstringoptionalMandatory if fileBody and jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: #### .txt, .csv, .json

jsonBodystringoptionalMandatory if fileUrl and fileBody is not defined. JSON content to be imported. Maximum allowed json body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files.

listIdsstringoptionalMandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].

newListstringoptionalTo create a new list and import the contacts into it, pass the listName and an optional folderId.

notifyUrlstringoptionalURL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

smsBlackliststringoptionalTo blacklist all the contacts for sms

updateExistingContactsstringoptionalTo facilitate the choice to update the existing contacts

brevomcp_contact_import_export_request_contact_export#Export contacts from your Brevo account based on custom filters. You must provide a customContactFilter with at least one action type (actionForContacts, actionForEmailCampaigns, or actionForSmsCampaigns). When using actionForContacts, either a listId or segmentId must be included.8 params▾

Export contacts from your Brevo account based on custom filters. You must provide a customContactFilter with at least one action type (actionForContacts, actionForEmailCampaigns, or actionForSmsCampaigns). When using actionForContacts, either a listId or segmentId must be included.

NameTypeRequiredDescription

customContactFilterstringrequiredSet the filter for the contacts to be exported.

disableNotificationstringoptionalTo avoid generating the email notification upon contact export, pass true

exportAttributesstringoptionalList of all the attributes that you want to export. These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. For example: ['fname', 'lname', 'email']

exportDateInUTCstringoptionalSpecifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format.

exportMandatoryAttributesstringoptionalTo export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME

exportMetadatastringoptionalExport metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.

exportSubscriptionStatusstringoptionalExport subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact.

notifyUrlstringoptionalWebhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

brevomcp_contact_import_export_update_batch_contacts#Update multiple contacts in a single API call by passing an array of contact objects, with a maximum of 100 contacts per request. Each contact in the array must be identified by exactly one of: email, id, or sms.1 param▾

Update multiple contacts in a single API call by passing an array of contact objects, with a maximum of 100 contacts per request. Each contact in the array must be identified by exactly one of: email, id, or sms.

NameTypeRequiredDescription

contactsstringrequiredList of contacts to be updated

brevomcp_contacts_create_contact#Creates new contacts on Brevo. Contacts can be created by passing either - 1. email address of the contact (email_id), 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} 3.8 params▾

Creates new contacts on Brevo. Contacts can be created by passing either - 1. email address of the contact (email_id), 2. phone number of the contact (to be passed as "SMS" field in "attributes" along with proper country code), For example- {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"} 3.

NameTypeRequiredDescription

attributesstringoptionalPass the set of attributes and their values. The attribute's parameter should be passed in capital letter while creating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored. These attributes must be present in your Brevo account. For eg: {"FNAME":"Elly", "LNAME":"Roger", "COUNTRIES": ["India","China"]}

emailstringoptionalEmail address of the user. Mandatory if "ext_id" & "SMS" field is not passed.

emailBlacklistedstringoptionalSet this field to blacklist the contact for emails (emailBlacklisted = true)

ext_idstringoptionalPass your own Id to create a contact.

listIdsstringoptionalIds of the lists to add the contact to

smsBlacklistedstringoptionalSet this field to blacklist the contact for SMS (smsBlacklisted = true)

smtpBlacklistSenderstringoptionaltransactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )

updateEnabledstringoptionalFacilitate to update the existing contact in the same request (updateEnabled = true)

brevomcp_contacts_delete_contact#Permanently delete a contact identified by their email address, numeric ID, or other identifier. Without the identifierType query parameter, the API only accepts email addresses (email_id) or numeric contact IDs (contact_id) as the path parameter.2 params▾

Permanently delete a contact identified by their email address, numeric ID, or other identifier. Without the identifierType query parameter, the API only accepts email addresses (email_id) or numeric contact IDs (contact_id) as the path parameter.

NameTypeRequiredDescription

identifierstringrequiredEmail (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded)

identifierTypestringoptionalemail_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

brevomcp_contacts_get_contact_info#Retrieve contact details by email, phone, or Brevo contact ID.4 params▾

Retrieve contact details by email, phone, or Brevo contact ID.

NameTypeRequiredDescription

identifierstringrequiredEmail (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded)

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date.

identifierTypestringoptionalemail_id for Email, phone_id for SMS attribute, contact_id for ID of the contact, ext_id for EXT_ID attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date.

brevomcp_contacts_get_contact_stats#Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes.3 params▾

Retrieve email campaign statistics for a specific contact identified by email address or numeric ID. Statistics include messages sent, opens, clicks, hard/soft bounces, deliveries, unsubscriptions, complaints, and transactional attributes.

NameTypeRequiredDescription

identifierstringrequiredEmail address (urlencoded) or numeric ID of the contact. If the value is numeric, it is treated as a contact ID; otherwise it is treated as an email address.

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Must not be greater than the current date. Maximum difference between startDate and endDate should not be greater than 90 days.

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate. Must not be greater than the current date.

brevomcp_contacts_get_contacts#Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting.9 params▾

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

NameTypeRequiredDescription

createdSincestringoptionalFilter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

filterstringoptionalFilter the contacts on the basis of attributes. Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"), filter=equals(GENDER, "1"), filter=equals(GENDER, "MALE"), filter=equals(COUNTRY,"USA, INDIA")

idsstringoptionalFilter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers.

limitstringoptionalNumber of documents per page

listIdsstringoptionalIds of the list. Either listIds or segmentId can be passed.

modifiedSincestringoptionalFilter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

offsetstringoptionalIndex of the first document of the page

segmentIdstringoptionalId of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1).

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_contacts_update_contact#Update an existing contact identified by their email address, numeric ID, or other identifier. Without the identifierType query parameter, only email addresses and numeric contact IDs are accepted as the path parameter.9 params▾

Update an existing contact identified by their email address, numeric ID, or other identifier. Without the identifierType query parameter, only email addresses and numeric contact IDs are accepted as the path parameter.

NameTypeRequiredDescription

identifierstringrequiredEmail (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded) OR its SMS attribute value OR its WHATSAPP attribute value OR its LANDLINE_NUMBER attribute value

attributesstringoptionalPass the set of attributes to be updated. These attributes must be present in your account. To update existing email address of a contact with the new one please pass EMAIL in attributes. For example, { "EMAIL":"newemail@domain.com", "FNAME":"Ellie", "LNAME":"Roger", "COUNTRIES":["India","China"]}. The attribute's parameter should be passed in capital letter while updating a contact. Values that don't match the attribute type (e.g. text or string in a date attribute) will be ignored .Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in SMS field should be passed with proper country code. For example: {"SMS":"+91xxxxxxxxxx"} or {"SMS":"0091xxxxxxxxxx"}

emailBlacklistedstringoptionalSet/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)

ext_idstringoptionalPass your own Id to update ext_id of a contact.

identifierTypestringoptionalemail_id for Email, contact_id for ID of the contact, ext_id for EXT_ID attribute, phone_id for SMS attribute, whatsapp_id for WHATSAPP attribute, landline_number_id for LANDLINE_NUMBER attribute

listIdsstringoptionalIds of the lists to add the contact to

smsBlacklistedstringoptionalSet/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)

smtpBlacklistSenderstringoptionaltransactional email forbidden sender for contact. Use only for email Contact

unlinkListIdsstringoptionalIds of the lists to remove the contact from

brevomcp_conversations_delete_messages_by_id#Delete a message sent by an agent. Only non-pushed, non-triggered agent messages from the chat widget can be deleted. Messages originating from external channels (email, SMS, etc.) cannot be deleted and will return a `400` error.1 param▾

Delete a message sent by an agent. Only non-pushed, non-triggered agent messages from the chat widget can be deleted. Messages originating from external channels (email, SMS, etc.) cannot be deleted and will return a `400` error.

NameTypeRequiredDescription

idstringrequiredID of the message

brevomcp_conversations_delete_pushed_messages_by_id#Delete an automated (pushed) message by its ID. Only messages that were originally sent via the pushed messages endpoint can be deleted using this endpoint. Returns `204` with an empty body on success.1 param▾

Delete an automated (pushed) message by its ID. Only messages that were originally sent via the pushed messages endpoint can be deleted using this endpoint. Returns `204` with an empty body on success.

NameTypeRequiredDescription

idstringrequiredID of the message

brevomcp_conversations_get_messages_by_id#Retrieve a single message by its ID. Both agent and visitor messages can be retrieved, but service messages (such as join/leave notifications) are excluded.1 param▾

Retrieve a single message by its ID. Both agent and visitor messages can be retrieved, but service messages (such as join/leave notifications) are excluded.

NameTypeRequiredDescription

idstringrequiredID of the message

brevomcp_conversations_get_pushed_messages_by_id#Retrieve a single automated (pushed) message by its ID. Only messages that were originally sent via the pushed messages endpoint can be retrieved using this endpoint; regular agent messages are not returned.1 param▾

Retrieve a single automated (pushed) message by its ID. Only messages that were originally sent via the pushed messages endpoint can be retrieved using this endpoint; regular agent messages are not returned.

NameTypeRequiredDescription

idstringrequiredID of the message sent previously

brevomcp_conversations_post_agent_online_ping#Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.5 params▾

Sets the agent's status to online for 2-3 minutes. We recommend pinging this endpoint every minute for as long as the agent has to be considered online. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.

NameTypeRequiredDescription

agentEmailstringoptionalAgent's email address. When sending online pings from a standalone system, it's hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there's no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically.

agentGroupsstringoptionalAn array of group IDs the agent should belong to. When provided, the agent is added to the listed groups and removed from any groups not in the list. Each ID must be a 17-character alphanumeric string.

agentIdstringoptionalAgent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).

agentNamestringoptionalAgent's name.

receivedFromstringoptionalMark your messages to distinguish messages created by you from the others.

brevomcp_conversations_post_messages#Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.6 params▾

Send a message as an agent to an existing visitor's conversation. You must provide either `agentId` alone, or all three of `agentEmail` + `agentName` + `receivedFrom` to identify the agent.

NameTypeRequiredDescription

textstringrequiredMessage text.

visitorIdstringrequiredVisitor's ID received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users">bind an existing user account to Conversations</a>.

agentEmailstringoptionalAgent's email address. When sending messages from a standalone system, it's hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there's no agent with the specified email address in your Brevo organization, a dummy agent will be created automatically.

agentIdstringoptionalAgent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).

agentNamestringoptionalAgent's name.

receivedFromstringoptionalMark your messages to distinguish messages created by you from the others. Useful in two-way integrations to filter out your own messages when received via a webhook.

brevomcp_conversations_post_pushed_messages#Send an automated (pushed) message to one or more visitors on behalf of an agent. Example use cases include order status updates, announcing new features, or proactive outreach. You can target a single visitor with `visitorId` or up to 250 visitors at once with `visitorIds`.6 params▾

Send an automated (pushed) message to one or more visitors on behalf of an agent. Example use cases include order status updates, announcing new features, or proactive outreach. You can target a single visitor with `visitorId` or up to 250 visitors at once with `visitorIds`.

NameTypeRequiredDescription

textstringrequiredMessage text.

agentIdstringoptionalAgent ID. It can be found on the agent's page or received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. If neither `agentId` nor `groupId` is specified, a random agent from your organization is selected.

groupIdstringoptionalGroup ID. It can be found on the group's page. A random agent from this group will be selected to send the message. Cannot be used together with `agentId`.

receivedFromstringoptionalMark your messages to distinguish messages created by you from the others. Useful in two-way integrations to filter out your own messages when received via a webhook.

visitorIdstringoptionalVisitor's ID received <a href="https://developers.brevo.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users">bind an existing user account to Conversations</a>. Either `visitorId` or `visitorIds` must be provided, but not both.

visitorIdsstringoptionalAn array of visitor IDs to send the message to in bulk. A maximum of 250 IDs can be specified per request. Duplicate IDs are automatically removed. When using this field, the API returns `201` with an empty body and messages are delivered asynchronously. Either `visitorId` or `visitorIds` must be provided, but not both.

brevomcp_conversations_put_messages_by_id#Update the text of a message sent by an agent. Only non-pushed, non-triggered agent messages from the chat widget can be edited. Messages originating from external channels (email, SMS, etc.) cannot be updated and will return a `400` error. The message text has a maximum length of 4096 characters.2 params▾

Update the text of a message sent by an agent. Only non-pushed, non-triggered agent messages from the chat widget can be edited. Messages originating from external channels (email, SMS, etc.) cannot be updated and will return a `400` error. The message text has a maximum length of 4096 characters.

NameTypeRequiredDescription

idstringrequiredID of the message

textstringrequiredThe new message text.

brevomcp_conversations_put_pushed_messages_by_id#Update the text of an automated (pushed) message. Only messages that were originally sent via the pushed messages endpoint can be updated using this endpoint. The message text has a maximum length of 4096 characters. The `text` and `html` fields of the message will be updated.2 params▾

Update the text of an automated (pushed) message. Only messages that were originally sent via the pushed messages endpoint can be updated using this endpoint. The message text has a maximum length of 4096 characters. The `text` and `html` fields of the message will be updated.

NameTypeRequiredDescription

idstringrequiredID of the message

textstringrequiredThe new message text.

brevomcp_coupons_create_coupon_collection#Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number.5 params▾

Create a new coupon collection with a name and a default coupon value. You can optionally set an expiration date in RFC3339 format and configure alert thresholds to receive email notifications when remaining coupons or remaining days before expiration fall below a specified number.

NameTypeRequiredDescription

defaultCouponstringrequiredDefault coupons collection name

namestringrequiredName of the coupons collection

expirationDatestringoptionalSpecify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

remainingCouponsAlertstringoptionalSend a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

remainingDaysAlertstringoptionalSend a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

brevomcp_coupons_create_coupons#Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance.2 params▾

Add coupons to an existing coupon collection. The `coupons` array must contain between 1 and 10,000 unique coupon code strings, all associated with the specified `collectionId`. Coupon creation is processed asynchronously and a `204` status is returned immediately upon acceptance.

NameTypeRequiredDescription

collectionIdstringrequiredThe id of the coupon collection for which the coupons will be created

couponsstringrequiredNo description.

brevomcp_coupons_get_coupon_collection#Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.1 param▾

Retrieve the details of a single coupon collection by its UUID. The response includes the collection name, default coupon value, total and remaining coupon counts, and creation timestamp. Returns a `404` error if no collection matches the provided ID.

NameTypeRequiredDescription

idstringrequiredId of the collection to return

brevomcp_coupons_get_coupon_collections#Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).4 params▾

Retrieve a paginated list of all coupon collections in your Brevo account. Results can be sorted by creation date, remaining coupons count, or expiration date, in ascending or descending order. Pagination defaults to 50 collections per page (maximum 100).

NameTypeRequiredDescription

limitstringoptionalNumber of documents returned per page

offsetstringoptionalIndex of the first document on the page

sortstringoptionalSort the results by creation time in ascending/descending order

sortBystringoptionalThe field used to sort coupon collections

brevomcp_coupons_update_coupon_collection#Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days.5 params▾

Update an existing coupon collection by its UUID. You can modify the default coupon value, set or remove the expiration date (pass `null` to remove), and configure or disable alert thresholds for remaining coupons or remaining days.

NameTypeRequiredDescription

idstringrequiredId of the collection to update

defaultCouponstringoptionalA default coupon to be used in case there are no coupons left

expirationDatestringoptionalSpecify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.

remainingCouponsAlertstringoptionalSend a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.

remainingDaysAlertstringoptionalSend a notification alert (email) when the remaining days until the expiration date are equal or fall bellow this number. Use null to disable alerts.

brevomcp_deals_delete_crm_deals_by_id#Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.1 param▾

Permanently delete a deal by its identifier. The requesting user must be the deal owner or have manage permission on deals; otherwise, a 403 Forbidden error is returned.

NameTypeRequiredDescription

idstringrequiredNo description.

brevomcp_deals_get_crm_deals#Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps.10 params▾

Retrieve a paginated list of deals with optional filtering, sorting, and search capabilities. Results can be filtered by attributes such as deal name or owner, linked companies, linked contacts, or modification/creation timestamps.

NameTypeRequiredDescription

createdSincestringoptionalFilter (urlencoded) the deals created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

filters_attributes_deal_namestringoptionalFilter by the deal name attribute.

filters_attributes_deal_ownerstringoptionalFilter deals by owner. Pass the account email of the deal owner.

filters_linkedCompaniesIdsstringoptionalFilter by linked companies ids

filters_linkedContactsIdsstringoptionalFilter by linked contacts ids

limitstringoptionalNumber of documents per page. Default is 50 if not specified.

modifiedSincestringoptionalFilter (urlencoded) the deals modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

sortBystringoptionalThe field used to sort field names.

brevomcp_deals_get_crm_deals_by_id#Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.1 param▾

Retrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies. Returns a 404 error if the deal does not exist.

NameTypeRequiredDescription

idstringrequiredNo description.

brevomcp_deals_patch_crm_deals_by_id#Update an existing deal's name or attributes. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs. To link or unlink contacts and companies, use the dedicated `/crm/deals/link-unlink/{id}` endpoint — those fields are not honored here.3 params▾

Update an existing deal's name or attributes. To move a deal to a different pipeline or stage, provide both the `pipeline` and `deal_stage` attribute IDs. To link or unlink contacts and companies, use the dedicated `/crm/deals/link-unlink/{id}` endpoint — those fields are not honored here.

NameTypeRequiredDescription

idstringrequiredNo description.

attributesstringoptionalAttributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage` Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`

namestringoptionalName of deal

brevomcp_deals_patch_crm_deals_link_unlink_by_id#Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body. At least one of the four arrays must contain values.5 params▾

Link or unlink contacts and companies with a specific deal in a single request. You can simultaneously link new contacts/companies and unlink existing ones by providing the respective ID arrays in the request body. At least one of the four arrays must contain values.

NameTypeRequiredDescription

idstringrequiredID of the deal to link or unlink entities with

linkCompanyIdsstringoptionalCompany IDs to be linked with the deal

linkContactIdsstringoptionalContact IDs for contacts to be linked with the deal

unlinkCompanyIdsstringoptionalCompany IDs to be unlinked from the deal

unlinkContactIdsstringoptionalContact IDs for contacts to be unlinked from the deal

brevomcp_deals_post_crm_deals#Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.4 params▾

Create a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies. You can assign the deal to a specific pipeline and stage by providing `pipeline` and `deal_stage` attribute IDs, which can be retrieved from the pipeline details endpoint.

NameTypeRequiredDescription

namestringrequiredName of deal

attributesstringoptionalAttributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`

linkedCompaniesIdsstringoptionalCompany ids to be linked with deal

linkedContactsIdsstringoptionalContact ids to be linked with deal

brevomcp_deals_post_crm_deals_import#Import deals in bulk from a CSV file with configurable mapping options. The CSV file must have the first row as column headers matching attribute internal names.0 params▾

Import deals in bulk from a CSV file with configurable mapping options. The CSV file must have the first row as column headers matching attribute internal names.

brevomcp_domains_authenticate_domain#Authenticates a specific domain.1 param▾

Authenticates a specific domain.

NameTypeRequiredDescription

domainNamestringrequiredDomain name

brevomcp_domains_create_domain#Creates a new domain in Brevo.1 param▾

Creates a new domain in Brevo.

NameTypeRequiredDescription

namestringrequiredDomain name to be added

brevomcp_domains_delete_domain#Deletes a domain from Brevo.1 param▾

Deletes a domain from Brevo.

NameTypeRequiredDescription

domainNamestringrequiredDomain name

brevomcp_domains_get_domain_configuration#Retrieves configuration of a specific domain, to know if the domain is valid or not.1 param▾

Retrieves configuration of a specific domain, to know if the domain is valid or not.

NameTypeRequiredDescription

domainNamestringrequiredDomain name

brevomcp_domains_get_domains#Retrieves all domains associated with the account.0 params▾

Retrieves all domains associated with the account.

brevomcp_ecommerce_create_batch_order#Create or update multiple ecommerce orders in a single asynchronous batch request. The `orders` array contains order objects (same schema as the single order endpoint).3 params▾

Create or update multiple ecommerce orders in a single asynchronous batch request. The `orders` array contains order objects (same schema as the single order endpoint).

NameTypeRequiredDescription

ordersstringrequiredarray of order objects

historicalstringoptionalDefines whether you want your orders to be considered as live data or as historical data (import of past data, synchronising data). True: orders will not trigger any automation workflows. False: orders will trigger workflows as usual.

notifyUrlstringoptionalWebhook URL to receive the status of the batch request

brevomcp_ecommerce_create_order#Create a new ecommerce order or update the status of an existing order. The order is identified by its unique `id` and requires a status, amount, creation and update timestamps, and a list of products with prices.11 params▾

Create a new ecommerce order or update the status of an existing order. The order is identified by its unique `id` and requires a status, amount, creation and update timestamps, and a list of products with prices.

NameTypeRequiredDescription

amountnumberrequiredTotal amount of the order, including all shipping expenses, tax and the price of items.

createdAtstringrequiredEvent occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.

idstringrequiredUnique ID of the order.

productsstringrequiredNo description.

statusstringrequiredState of the order.

updatedAtstringrequiredEvent updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.

billingstringoptionalBilling details of an order.

couponsstringoptionalCoupons applied to the order. Stored case insensitive.

identifiersstringoptionalIdentifies the contact associated with the order.

metaInfostringoptionalMeta data of order to store additional detail such as custom message, customer type, source.

storeIdstringoptionalID of store where the order is placed

brevomcp_ecommerce_get_attribution_metrics#Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format.6 params▾

Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using `periodFrom` and `periodTo` in RFC3339 format.

NameTypeRequiredDescription

automationWorkflowEmailId_stringoptionalThe automation workflow ID(s) to get email attribution metrics for

automationWorkflowSmsId_stringoptionalThe automation workflow ID(s) to get SMS attribution metrics for

emailCampaignId_stringoptionalThe email campaign ID(s) to get metrics for

periodFromstringoptionalWhen getting metrics for a specific period, define the starting datetime in RFC3339 format

periodTostringoptionalWhen getting metrics for a specific period, define the end datetime in RFC3339 format

smsCampaignId_stringoptionalThe SMS campaign ID(s) to get metrics for

brevomcp_ecommerce_get_attribution_metrics_by_conversion_source_id#Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.2 params▾

Retrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID. The response includes orders count, revenue, average basket value, and the number of new customers attributed to that specific campaign or workflow.

NameTypeRequiredDescription

conversionSourcestringrequiredThe Brevo campaign type or workflow type for which data will be retrieved

conversionSourceIdstringrequiredThe Brevo campaign or automation workflow id for which data will be retrieved

brevomcp_ecommerce_get_attribution_products_by_conversion_source_id#Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count.2 params▾

Retrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow. Each product entry includes its ID, name, SKU, image URL, product URL, price, revenue, and orders count.

NameTypeRequiredDescription

conversionSourcestringrequiredThe Brevo campaign or automation workflow type for which data will be retrieved

conversionSourceIdstringrequiredThe Brevo campaign or automation workflow id for which data will be retrieved

brevomcp_ecommerce_get_config_display_currency#Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.0 params▾

Retrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account. This currency is used to display monetary values across the ecommerce dashboard and reports. Returns a `403` error if ecommerce is not activated on the account.

brevomcp_ecommerce_get_orders#Retrieve a paginated list of all ecommerce orders stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by modification date or creation date. Pagination defaults to 50 orders per page (maximum 100).5 params▾

Retrieve a paginated list of all ecommerce orders stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by modification date or creation date. Pagination defaults to 50 orders per page (maximum 100).

NameTypeRequiredDescription

createdSincestringoptionalFilter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

limitstringoptionalNumber of documents per page

modifiedSincestringoptionalFilter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_ecommerce_post_activate#Activate the Brevo eCommerce application for your account. This is a prerequisite for using other ecommerce endpoints such as products, categories, and orders. Activation is asynchronous and typically takes up to 5 minutes to complete.0 params▾

Activate the Brevo eCommerce application for your account. This is a prerequisite for using other ecommerce endpoints such as products, categories, and orders. Activation is asynchronous and typically takes up to 5 minutes to complete.

brevomcp_ecommerce_set_config_display_currency#Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error.1 param▾

Set or update the ISO 4217 display currency code for your Brevo ecommerce account. This currency determines how monetary values are displayed in the ecommerce dashboard and reports. The provided currency code must be a valid ISO 4217 code; invalid codes result in a `422` error.

NameTypeRequiredDescription

codestringrequiredISO 4217 compliant display currency code

brevomcp_email_campaign_management_create_email_campaign#Create a new email campaign. The campaign requires at minimum a name and sender details, and is created in draft status by default.32 params▾

Create a new email campaign. The campaign requires at minimum a name and sender details, and is created in draft status by default.

NameTypeRequiredDescription

namestringrequiredName of the campaign

senderstringrequiredSender details including id or email and name (optional). Only one of either Sender’s email or Sender’s ID shall be passed in one request at a time. Passing both `email` and `id` will result in an error. For example: {"name":"xyz", "email":"example@abc.com"} or {"name":"xyz", "id":123}

abTestingstringoptionalStatus of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. subjectA, subjectB, splitRule, winnerCriteria & winnerDelay will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. Can be set to true only if sendAtBestTime is false. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B

attachmentUrlstringoptionalAbsolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps

emailExpirationDatestringoptionalTo reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy. Learn more about setting an email expiration date. For reference , ``https://help.brevo.com/hc/en-us/articles/4413566705298-Create-an-email-campaign``

footerstringoptionalFooter of the email campaign

headerstringoptionalHeader of the email campaign

htmlContentstringoptionalMandatory if htmlUrl and templateId are empty. Body of the message (HTML). Must have more than 10 characters and be less than 1MB in size. Cannot be used together with `htmlUrl` or `templateId`.

htmlUrlstringoptionalMandatory if htmlContent and templateId are empty. URL to the message (HTML). Cannot be used together with `htmlContent` or `templateId`. For example: https://html.domain.com

increaseRatestringoptionalMandatory if ipWarmupEnable is set to true. Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.

initialQuotastringoptionalMandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.

inlineImageActivationstringoptionalUse true to embedded the images in your email. Final size of the email should be less than 4MB. Campaigns with embedded images can _not be sent to more than 5000 contacts_

ipWarmupEnablestringoptionalAvailable for dedicated ip clients. Set this to true if you wish to warm up your ip.

mirrorActivestringoptionalUse true to enable the mirror link

paramsstringoptionalPass the set of attributes to customize the type classic campaign. For example: {"FNAME":"Joe", "LNAME":"Doe"}. Only available if type is classic. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField

previewTextstringoptionalPreview text or preheader of the email campaign

recipientsstringoptionalSegment ids and List ids to include/exclude from campaign

replyTostringoptionalEmail on which the campaign recipients will be able to reply to

scheduledAtstringoptionalSending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part). For example: 2017-06-01T12:30:00+02:00

sendAtBestTimestringoptionalSet this to true if you want to send your campaign at best time.

splitRulestringoptionalAdd the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else

subjectstringoptionalSubject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.

subjectAstringoptionalSubject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

subjectBstringoptionalSubject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

tagstringoptionalTag of the campaign

templateIdstringoptionalMandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status _active_. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature. Cannot be used together with `htmlContent` or `htmlUrl`.

toFieldstringoptionalTo personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

unsubscriptionPageIdstringoptionalEnter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page. If not entered, then the default unsubscription page will be used.

updateFormIdstringoptionalMandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form. If not entered, then the default update profile form will be used.

utmCampaignstringoptionalCustomize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed

winnerCriteriastringoptionalChoose the metrics that will determinate the winning version. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerCriteria` is ignored if passed

winnerDelaystringoptionalChoose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerDelay` is ignored if passed

brevomcp_email_campaign_management_delete_email_campaign#Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted; attempting to delete a campaign that has already been scheduled will return a 403 permission denied error.1 param▾

Delete an email campaign by its campaign ID. Only campaigns that have not been scheduled can be deleted; attempting to delete a campaign that has already been scheduled will return a 403 permission denied error.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

brevomcp_email_campaign_management_email_export_recipients#Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export.3 params▾

Export the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g. openers, clickers, hardBounces). The recipientsType field is required and determines which subset of recipients to export.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

recipientsTypestringrequiredType of recipients to export for a campaign

notifyURLstringoptionalWebhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

brevomcp_email_campaign_management_get_email_campaign#Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content.3 params▾

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

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

excludeHtmlContentstringoptionalUse this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body

statisticsstringoptionalFilter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. `statsByDevice` and `statsByBrowser` are only available when retrieving a single campaign (not in the list endpoint).

brevomcp_email_campaign_management_get_email_campaigns#No description available.10 params▾

No description available.

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future.

excludeHtmlContentstringoptionalUse this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body.

excludePdfAttachmentstringoptionalUse this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned.

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future.

statisticsstringoptionalFilter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the Get Campaign Report endpoint.

statusstringoptionalFilter on the status of the campaign

typestringoptionalFilter on the type of the campaigns

brevomcp_email_campaign_management_get_shared_template_url#Get a unique URL to share and import an email template from one Brevo account to another. Only classic email campaigns and templates are supported; attempting to get a shared URL for other campaign types will return a 405 error.1 param▾

Get a unique URL to share and import an email template from one Brevo account to another. Only classic email campaigns and templates are supported; attempting to get a shared URL for other campaign types will return a 405 error.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign or template

brevomcp_email_campaign_management_send_email_campaign_now#Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content configured before sending. The system verifies your account's send limit and credit balance before dispatching; if credits are insufficient, a 402 error is returned.1 param▾

Send an existing email campaign immediately by scheduling it for the current time. The campaign must have valid recipients and content configured before sending. The system verifies your account's send limit and credit balance before dispatching; if credits are insufficient, a 402 error is returned.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

brevomcp_email_campaign_management_send_report#Send a PDF report of an email campaign to the specified email addresses. The report includes campaign statistics such as deliveries, opens, clicks, bounces, and unsubscriptions. The email recipients list supports a maximum of 99 addresses, and a custom body text is required.3 params▾

Send a PDF report of an email campaign to the specified email addresses. The report includes campaign statistics such as deliveries, opens, clicks, bounces, and unsubscriptions. The email recipients list supports a maximum of 99 addresses, and a custom body text is required.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

emailstringrequiredCustom attributes for the report email.

languagestringoptionalLanguage of email content for campaign report sending.

brevomcp_email_campaign_management_send_test_email#Send a test version of an email campaign to specified email addresses or your entire test list. If the emailTo array is left empty, the test mail will be sent to all addresses in your test list. You can send a maximum of 50 test emails per day.2 params▾

Send a test version of an email campaign to specified email addresses or your entire test list. If the emailTo array is left empty, the test mail will be sent to all addresses in your test list. You can send a maximum of 50 test emails per day.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

emailTostringoptionalList of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_.

brevomcp_email_campaign_management_update_campaign_status#Update the status of an email campaign, such as suspending, archiving, or replicating it. Available status values are: suspended, archive, darchive, sent, queued, replicate, replicateTemplate, and draft.2 params▾

Update the status of an email campaign, such as suspending, archiving, or replicating it. Available status values are: suspended, archive, darchive, sent, queued, replicate, replicateTemplate, and draft.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

statusstringoptionalNote:- replicateTemplate status will be available only for template type campaigns.

brevomcp_email_campaign_management_update_email_campaign#Update an existing email campaign's properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration. The campaign must exist and the request body must contain at least one valid field to update.33 params▾

Update an existing email campaign's properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration. The campaign must exist and the request body must contain at least one valid field to update.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

abTestingstringoptionalStatus of A/B Test. abTesting = false means it is disabled & abTesting = true means it is enabled. subjectA, subjectB, splitRule, winnerCriteria & winnerDelay will be considered when abTesting is set to true. subjectA & subjectB are mandatory together & subject if passed is ignored. Can be set to true only if sendAtBestTime is false. You will be able to set up two subject lines for your campaign and send them to a random sample of your total recipients. Half of the test group will receive version A, and the other half will receive version B

attachmentUrlstringoptionalAbsolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'

emailExpirationDatestringoptionalTo reduce your carbon footprint, set an expiration date for your email. If supported, it will be automatically deleted from the recipient’s inbox, saving storage space and energy.

footerstringoptionalFooter of the email campaign

headerstringoptionalHeader of the email campaign

htmlContentstringoptionalBody of the message (HTML version). If the campaign is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl is empty

htmlUrlstringoptionalUrl which contents the body of the email message. REQUIRED if htmlContent is empty

increaseRatestringoptionalSet a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.

initialQuotastringoptionalSet an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.

inlineImageActivationstringoptionalStatus of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email _must be sent to less than 5000 contacts_.

ipWarmupEnablestringoptionalAvailable for dedicated ip clients. Set this to true if you wish to warm up your ip.

mirrorActivestringoptionalStatus of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign

namestringoptionalName of the campaign

paramsstringoptionalPass the set of attributes to customize the type classic campaign. For example: {"FNAME":"Joe", "LNAME":"Doe"}. Only available if type is classic. It's considered only if campaign is in _New Template Language format_. The New Template Language is dependent on the values of subject, htmlContent/htmlUrl, sender.name & toField

previewTextstringoptionalPreview text or preheader of the email campaign

recipientsstringoptionalSegment ids and List ids to include/exclude from campaign

recurringstringoptionalFOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times

replyTostringoptionalEmail on which campaign recipients will be able to reply to

scheduledAtstringoptionalUTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).

sendAtBestTimestringoptionalSet this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.

senderstringoptionalSender details including id or email and name (optional). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}

splitRulestringoptionalAdd the size of your test groups. Mandatory if abTesting = true & 'recipients' is passed. We'll send version A and B to a random sample of recipients, and then the winning version to everyone else

subjectstringoptionalSubject of the campaign

subjectAstringoptionalSubject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

subjectBstringoptionalSubject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value

tagstringoptionalTag of the campaign

toFieldstringoptionalTo personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

unsubscriptionPageIdstringoptionalEnter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.

updateFormIdstringoptionalMandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.

utmCampaignstringoptionalCustomize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed

winnerCriteriastringoptionalChoose the metrics that will determinate the winning version. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerCriteria` is ignored if passed

winnerDelaystringoptionalChoose the duration of the test in hours. Maximum is 7 days, pass 24*7 = 168 hours. The winning version will be sent at the end of the test. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerDelay` is ignored if passed

brevomcp_email_campaign_management_upload_image_to_gallery#Upload an image to your account's image gallery by providing an absolute URL to the image. The maximum allowed image size is 2MB and supported formats are jpeg, jpg, png, bmp, and gif; local file uploads are not supported.2 params▾

Upload an image to your account's image gallery by providing an absolute URL to the image. The maximum allowed image size is 2MB and supported formats are jpeg, jpg, png, bmp, and gif; local file uploads are not supported.

NameTypeRequiredDescription

imageUrlstringrequiredThe absolute url of the image (no local file). Maximum allowed size for image is 2MB. Allowed extensions for images are: #### jpeg, jpg, png, bmp, gif.

namestringoptionalName of the image.

brevomcp_events_create_event#Create a single event to record a contact's interaction. The event is processed asynchronously and can be used for segmentation, automation triggers, and analytics. Each event must include at least one contact identifier.6 params▾

Create a single event to record a contact's interaction. The event is processed asynchronously and can be used for segmentation, automation triggers, and analytics. Each event must include at least one contact identifier.

NameTypeRequiredDescription

event_namestringrequiredThe name of the event that occurred. This is how you will find your event in Brevo. Limited to 255 characters; only alphanumeric characters, hyphens (-), and underscores (_) are allowed.

identifiersstringrequiredIdentifies the contact associated with the event. At least one identifier is required. Each identifier value is limited to 255 characters.

contact_propertiesstringoptionalProperties defining the state of the contact associated to this event. Useful to update contact attributes defined in your contacts database while passing the event. Only string, number, and boolean values are accepted. For example: "FIRSTNAME": "Jane" , "AGE": 37

event_datestringoptionalISO 8601 / RFC 3339 timestamp of when the event occurred (e.g. "2024-01-24T17:39:57+01:00"). Cannot be in the future or before 1970-01-01. If no value is passed, the timestamp of the event creation is used.

event_propertiesstringoptionalProperties of the event. Top level properties and nested properties can be used to better segment contacts and personalise workflow conditions. The following field types are supported: string, number, boolean (true/false), date (Timestamp e.g. "2024-01-24T17:39:57+01:00"). Keys are limited to 255 characters, alphanumerical characters and - _ only. Size is limited to 50 KB.

objectstringoptionalIdentifiers of the object record associated with this event. Ignored if the object type or identifier for this record does not exist on the account. When provided, both `type` and at least one identifier (`ext_id` or `id`) are required.

brevomcp_events_get_events#Retrieve a paginated list of events filtered by contact ID, event name, object type, and/or date range. When no date range is provided, the API returns events from the last 6 months by default. Results are ordered by event date descending. Use the `count` field in the response for pagination.7 params▾

Retrieve a paginated list of events filtered by contact ID, event name, object type, and/or date range. When no date range is provided, the API returns events from the last 6 months by default. Results are ordered by event date descending. Use the `count` field in the response for pagination.

NameTypeRequiredDescription

contact_idstringoptionalFilter by contact ID (repeatable).

endDatestringoptionalMandatory if startDate is used. End of date range (YYYY-MM-DD or RFC3339). Must be strictly greater than startDate. The date range between startDate and endDate must not exceed 6 months.

event_namestringoptionalFilter by event name (repeatable).

limitstringoptionalMaximum number of events to return. Default 100, minimum 1, maximum 10000.

object_typestringoptionalFilter by object type (repeatable).

offsetstringoptionalNumber of events to skip for pagination. Default 0, minimum 0.

startDatestringoptionalMandatory if endDate is used. Start of date range (YYYY-MM-DD or RFC3339). Defaults to 6 months ago when omitted alongside endDate. Must be before endDate and after 1970-01-01.

brevomcp_external_feeds_create_external_feed#Creates a new external feed for dynamic content in email campaigns.9 params▾

Creates a new external feed for dynamic content in email campaigns.

NameTypeRequiredDescription

namestringrequiredName of the feed

urlstringrequiredURL of the external data source

authTypestringoptionalAuthentication type for accessing the feed

cachestringoptionalWhether to cache the feed response

headersstringoptionalCustom HTTP headers for the feed request

maxRetriesstringoptionalMaximum number of retry attempts for failed requests

passwordstringoptionalPassword for basic authentication (required if authType is 'basic')

tokenstringoptionalToken for token-based authentication (required if authType is 'token')

usernamestringoptionalUsername for basic authentication (required if authType is 'basic')

brevomcp_external_feeds_delete_external_feed#Deletes an external feed from your Brevo account.1 param▾

Deletes an external feed from your Brevo account.

NameTypeRequiredDescription

uuidstringrequiredUUID of the feed to delete

brevomcp_external_feeds_get_all_external_feeds#Retrieves all external feeds from your Brevo account with filtering and pagination.7 params▾

Retrieves all external feeds from your Brevo account with filtering and pagination.

NameTypeRequiredDescription

authTypestringoptionalFilter the records by `authType` of the feed.

endDatestringoptionalMandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

limitstringoptionalNumber of documents returned per page.

offsetstringoptionalIndex of the first document on the page.

searchstringoptionalCan be used to filter records by search keyword on feed name

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed.

startDatestringoptionalMandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.

brevomcp_external_feeds_get_external_feed_by_uuid#Retrieves details of a specific external feed by its UUID.1 param▾

Retrieves details of a specific external feed by its UUID.

NameTypeRequiredDescription

uuidstringrequiredUUID of the feed to fetch

brevomcp_external_feeds_update_external_feed#Updates configuration of an existing external feed.10 params▾

Updates configuration of an existing external feed.

NameTypeRequiredDescription

uuidstringrequiredUUID of the feed to update

authTypestringoptionalAuthentication type for accessing the feed

cachestringoptionalWhether to cache the feed response

headersstringoptionalCustom HTTP headers for the feed request. New headers are merged with existing ones (matching names are replaced).

maxRetriesstringoptionalMaximum number of retry attempts for failed requests

namestringoptionalName of the feed

passwordstringoptionalPassword for basic authentication

tokenstringoptionalToken for token-based authentication

urlstringoptionalURL of the external data source

usernamestringoptionalUsername for basic authentication

brevomcp_files_delete_crm_files_by_id#Permanently delete a CRM file by its identifier. This removes the file from storage and unlinks it from any associated contacts, companies, or deals.1 param▾

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

NameTypeRequiredDescription

idstringrequiredFile id to delete.

brevomcp_files_get_crm_files#Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.7 params▾

Retrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 files per page.

NameTypeRequiredDescription

dateFromstringoptionaldateFrom to date range filter type (timestamp in milliseconds)

dateTostringoptionaldateTo to date range filter type (timestamp in milliseconds)

entitystringoptionalFilter by file entity type

entityIdsstringoptionalFilter by file entity IDs

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

brevomcp_files_get_crm_files_by_id#Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.1 param▾

Get a temporary download URL for a CRM file by its identifier. The returned URL is valid for 5 minutes only and provides direct access to the file content.

NameTypeRequiredDescription

idstringrequiredFile id to download.

brevomcp_files_get_crm_files_data#Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, author, creation date, and associated contacts, companies, or deals.1 param▾

Retrieve the metadata and details of a specific CRM file by its identifier. This returns information such as the file name, size, author, creation date, and associated contacts, companies, or deals.

NameTypeRequiredDescription

idstringrequiredFile ID to retrieve file data for

brevomcp_files_post_crm_files#Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.0 params▾

Upload a file and associate it with a contact, company, or deal. The file must be sent as multipart form data with a maximum size of 10 MB. You can optionally link the file to a specific entity by providing the corresponding entity ID.

brevomcp_folders_create_folder#Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.1 param▾

Create a new folder to organize your contact lists. Folders serve as containers for grouping related lists together. The folder name is required and must be provided in the request body.

NameTypeRequiredDescription

namestringrequiredName of the folder

brevomcp_folders_delete_folder#Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.1 param▾

Permanently delete a folder identified by its ID. Deleting a folder will also delete all the contact lists contained within it. This action cannot be undone.

NameTypeRequiredDescription

folderIdintegerrequiredId of the folder

brevomcp_folders_get_folder#Retrieve the details of a specific folder by its ID, including its name, subscriber counts, and blacklisted contacts count. Note: the totalSubscribers and totalBlacklisted response attributes are being deprecated and will return 0 as their default value.1 param▾

Retrieve the details of a specific folder by its ID, including its name, subscriber counts, and blacklisted contacts count. Note: the totalSubscribers and totalBlacklisted response attributes are being deprecated and will return 0 as their default value.

NameTypeRequiredDescription

folderIdintegerrequiredid of the folder

brevomcp_folders_get_folder_lists#Retrieve all contact lists contained in a specific folder, identified by its folder ID. Results are paginated with a default of 10 lists per page (maximum 50) sorted in descending order of creation.4 params▾

Retrieve all contact lists contained in a specific folder, identified by its folder ID. Results are paginated with a default of 10 lists per page (maximum 50) sorted in descending order of creation.

NameTypeRequiredDescription

folderIdintegerrequiredId of the folder

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_folders_get_folders#Retrieve all contact folders from your Brevo account with support for pagination and sorting. Results default to 10 folders per page (maximum 50) sorted in descending order of creation.3 params▾

Retrieve all contact folders from your Brevo account with support for pagination and sorting. Results default to 10 folders per page (maximum 50) sorted in descending order of creation.

NameTypeRequiredDescription

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_folders_update_folder#Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.2 params▾

Update the name of an existing folder identified by its ID. The new folder name must be provided in the request body. Returns a 404 error if the folder ID does not exist.

NameTypeRequiredDescription

folderIdintegerrequiredId of the folder

namestringrequiredName of the folder

brevomcp_groups_delete_corporate_group_by_id#Deletes a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group, but the sub-organizations themselves are not deleted. The users associated with the group are also disassociated once the group is removed.1 param▾

Deletes a group of sub-organizations. When a group is deleted, the sub-organizations are no longer part of this group, but the sub-organizations themselves are not deleted. The users associated with the group are also disassociated once the group is removed.

NameTypeRequiredDescription

idstringrequiredId of the group

brevomcp_groups_get_corporate_group_by_id#Retrieves detailed information about a specific group of sub-organizations, including the group metadata, list of sub-organizations belonging to the group, and the users associated with it. The caller must have edit/delete permissions on sub-organization groups to access this endpoint.1 param▾

Retrieves detailed information about a specific group of sub-organizations, including the group metadata, list of sub-organizations belonging to the group, and the users associated with it. The caller must have edit/delete permissions on sub-organization groups to access this endpoint.

NameTypeRequiredDescription

idstringrequiredId of the group of sub-organization

brevomcp_groups_get_sub_account_groups#Retrieves all groups created on the corporate admin account. Each group entry includes the group name and its unique identifier. Groups are used to organize sub-accounts for easier management and permission assignment.0 params▾

Retrieves all groups created on the corporate admin account. Each group entry includes the group name and its unique identifier. Groups are used to organize sub-accounts for easier management and permission assignment.

brevomcp_groups_post_corporate_group#Creates a new group to organize sub-accounts under the corporate master account. Groups allow you to manage and apply settings to multiple sub-accounts at once. A group name is required, and you can optionally assign sub-account IDs to the group at creation time.2 params▾

Creates a new group to organize sub-accounts under the corporate master account. Groups allow you to manage and apply settings to multiple sub-accounts at once. A group name is required, and you can optionally assign sub-account IDs to the group at creation time.

NameTypeRequiredDescription

groupNamestringrequiredThe name of the group of sub-accounts

subAccountIdsstringoptionalPass the list of sub-account Ids to be included in the group

brevomcp_groups_put_corporate_group_by_id#Updates the details of an existing group of sub-accounts, including the group name and the list of sub-accounts assigned to it. When sub-account IDs are provided, the group membership is replaced with the new list. Omitting a field leaves it unchanged.3 params▾

Updates the details of an existing group of sub-accounts, including the group name and the list of sub-accounts assigned to it. When sub-account IDs are provided, the group membership is replaced with the new list. Omitting a field leaves it unchanged.

NameTypeRequiredDescription

idstringrequiredId of the group

groupNamestringoptionalThe name of the group of sub-accounts

subAccountIdsstringoptionalPass the list of sub-account Ids to be included in the group

brevomcp_groups_put_corporate_group_unlink_sub_accounts#Removes one or more sub-organizations from a specific group. The sub-organizations themselves are not deleted; they are simply unlinked from the group. All sub-account IDs in the request must be positive integers.2 params▾

Removes one or more sub-organizations from a specific group. The sub-organizations themselves are not deleted; they are simply unlinked from the group. All sub-account IDs in the request must be positive integers.

NameTypeRequiredDescription

groupIdstringrequiredGroup id

subAccountIdsstringrequiredList of sub-account ids to remove from the group

brevomcp_inbound_get_email_attachment#Download an inbound email attachment using its download token. The download token is obtained from the attachments list in the response of the `GET /inbound/events/{uuid}` endpoint.1 param▾

Download an inbound email attachment using its download token. The download token is obtained from the attachments list in the response of the `GET /inbound/events/{uuid}` endpoint.

NameTypeRequiredDescription

downloadTokenstringrequiredToken to fetch a particular attachment.

brevomcp_inbound_get_email_events#Retrieve a paginated list of inbound email events. When no date range is provided, the API returns events from the last 30 days by default. Both `startDate` and `endDate` must be provided together; the maximum date range that can be selected is 30 days.6 params▾

Retrieve a paginated list of inbound email events. When no date range is provided, the API returns events from the last 30 days by default. Both `startDate` and `endDate` must be provided together; the maximum date range that can be selected is 30 days.

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future.

limitstringoptionalNumber of documents returned per page. Default 100, minimum 1, maximum 500.

offsetstringoptionalIndex of the first document on the page. Default 0, minimum 0.

senderstringoptionalEmail address of the sender. Must be a valid email address when provided.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default is descending.

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is 30 days. Must not be in the future and must be before endDate.

brevomcp_inbound_get_email_events_by_uuid#Retrieve the detailed event history for a specific received email identified by its UUID. The response includes sender and recipient information, the email subject, a list of attachments, and a chronological log of processing events (received, processed, webhook delivery attempts).1 param▾

Retrieve the detailed event history for a specific received email identified by its UUID. The response includes sender and recipient information, the email subject, a list of attachments, and a chronological log of processing events (received, processed, webhook delivery attempts).

NameTypeRequiredDescription

uuidstringrequiredUUID to fetch events specific to a received email. Must be a valid UUID format.

brevomcp_ips_get_from_sender#Retrieves the dedicated IPs associated with a specific sender.1 param▾

Retrieves the dedicated IPs associated with a specific sender.

NameTypeRequiredDescription

senderIdintegerrequiredId of the sender

brevomcp_ips_get_ips#Retrieves all dedicated IPs associated with your Brevo account.0 params▾

Retrieves all dedicated IPs associated with your Brevo account.

brevomcp_lists_add_contact_to_list#Add existing contacts to a specific list by providing their email addresses, numeric IDs, or EXT_ID attributes. Only one type of identifier can be used per request, with a maximum of 150 contacts per call. The response includes separate arrays for successfully added and failed contacts.4 params▾

Add existing contacts to a specific list by providing their email addresses, numeric IDs, or EXT_ID attributes. Only one type of identifier can be used per request, with a maximum of 150 contacts per call. The response includes separate arrays for successfully added and failed contacts.

NameTypeRequiredDescription

listIdintegerrequiredId of the list

emailsstringoptionalEmails to add to a list. You can pass a maximum of 150 emails for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._

extIdsstringoptionalEXT_ID attributes to add to a list. You can pass a maximum of 150 EXT_ID attributes for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._

idsstringoptionalIDs to add to a list. You can pass a maximum of 150 IDs for addition in one request. _If you need to add the emails in bulk, please prefer /contacts/import api._

brevomcp_lists_create_list#Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.2 params▾

Create a new contact list inside a specified folder. Both the list name and the parent folder ID are required. The newly created list will be empty and ready to receive contacts via the add contacts endpoint.

NameTypeRequiredDescription

folderIdintegerrequiredId of the parent folder in which this list is to be created

namestringrequiredName of the list

brevomcp_lists_delete_list#Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.1 param▾

Permanently delete a contact list identified by its ID. The contacts in the list are not deleted; they are only removed from this list. Returns a 404 error if the list ID does not exist.

NameTypeRequiredDescription

listIdintegerrequiredId of the list

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

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

NameTypeRequiredDescription

listIdintegerrequiredId of the list

endDatestringoptionalMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result. If not provided, defaults to the current date. The difference between startDate and endDate must not exceed 2 years.

startDatestringoptionalMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a specific list id. Prefer to pass your timezone in date-time format for accurate result. If not provided, defaults to 6 months ago.

brevomcp_lists_get_lists#Retrieve all contact lists from your Brevo account with support for pagination and sorting. Results default to 10 lists per page (maximum 50) sorted in descending order of creation.3 params▾

Retrieve all contact lists from your Brevo account with support for pagination and sorting. Results default to 10 lists per page (maximum 50) sorted in descending order of creation.

NameTypeRequiredDescription

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_lists_remove_contact_from_list#Remove contacts from a specific list by providing their email addresses, numeric IDs, EXT_ID attributes, or by setting "all" to true to remove all contacts from the list. Only one type of identifier can be used per request, with a maximum of 150 contacts per call.5 params▾

Remove contacts from a specific list by providing their email addresses, numeric IDs, EXT_ID attributes, or by setting "all" to true to remove all contacts from the list. Only one type of identifier can be used per request, with a maximum of 150 contacts per call.

NameTypeRequiredDescription

listIdintegerrequiredId of the list

allstringoptionalRequired if 'emails', 'extIds' and 'ids' are empty. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress

emailsstringoptionalRequired if 'all' is false and 'ids', 'extIds' are empty. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.

extIdsstringoptionalRequired if 'all' is false, 'ids' and 'emails' are empty. EXT_ID attributes to remove from a list. You can pass a maximum of 150 EXT_ID attributes for removal in one request.

idsstringoptionalRequired if 'all' is false and 'emails', 'extIds' are empty. IDs to remove from a list. You can pass a maximum of 150 IDs for removal in one request.

brevomcp_lists_update_list#Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.3 params▾

Update an existing contact list identified by its ID. You can update the list name, move it to a different folder by providing a new folderId, or both. Only one of the two parameters (name, folderId) needs to be provided per request.

NameTypeRequiredDescription

listIdintegerrequiredId of the list

folderIdstringoptionalId of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.

namestringoptionalName of the list. Either of the two parameters (name, folderId) can be updated at a time.

brevomcp_loyalty_add_subscription_to_tier#Manually assigns a tier to a contact's subscription in a loyalty program. The contact must have an active subscription. An optional request body can include metadata and a creation date (must be in the past). This operation takes effect immediately without requiring a program publication.3 params▾

Manually assigns a tier to a contact's subscription in a loyalty program. The contact must have an active subscription. An optional request body can include metadata and a creation date (must be in the past). This operation takes effect immediately without requiring a program publication.

NameTypeRequiredDescription

cidintegerrequiredContact ID

pidstringrequiredLoyalty Program ID

tidstringrequiredTier ID

brevomcp_loyalty_begin_transaction#Creates a new balance transaction (credit or debit) within a loyalty program. A positive amount creates a credit transaction and a negative amount creates a debit transaction by default, unless `transactionType` is explicitly provided.11 params▾

Creates a new balance transaction (credit or debit) within a loyalty program. A positive amount creates a credit transaction and a negative amount creates a debit transaction by default, unless `transactionType` is explicitly provided.

NameTypeRequiredDescription

amountnumberrequiredTransaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided).

balanceDefinitionIdstringrequiredUnique identifier (UUID) of the associated balance definition.

pidstringrequiredLoyalty Program Id

autoCompletestringoptionalWhether the transaction should be automatically completed.

balanceExpiryInMinutesstringoptionalExpiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true.

contactIdstringoptionalUnique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided.

eventTimestringoptionalTimestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format).

LoyaltySubscriptionIdstringoptionalUnique identifier for the loyalty subscription. Required unless `contactId` is provided.

metastringoptionalOptional metadata associated with the transaction.

transactionTypestringoptionalExplicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).

ttlstringoptionalTime-to-live for the transaction in seconds. Must be at least 10 seconds if provided.

brevomcp_loyalty_cancel_transaction#Cancels a pending transaction, reverting any tentative balance changes. Only transactions in a pending state can be cancelled. Once cancelled, the transaction cannot be completed or modified further.2 params▾

Cancels a pending transaction, reverting any tentative balance changes. Only transactions in a pending state can be cancelled. Once cancelled, the transaction cannot be completed or modified further.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program Id

tidstringrequiredTransaction Id

brevomcp_loyalty_complete_redeem_transaction#Completes a pending voucher redemption request. Only redemptions in a pending state can be completed. Once completed, the voucher is marked as consumed and any associated balance deductions are finalized.2 params▾

Completes a pending voucher redemption request. Only redemptions in a pending state can be completed. Once completed, the voucher is marked as consumed and any associated balance deductions are finalized.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

tidstringrequiredRedeem transaction ID

brevomcp_loyalty_complete_transaction#Completes a pending transaction, finalizing the balance change. Only transactions in a pending state can be completed. Once completed, the transaction amount is permanently applied to the contact's balance.2 params▾

Completes a pending transaction, finalizing the balance change. Only transactions in a pending state can be completed. Once completed, the transaction amount is permanently applied to the contact's balance.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program Id

tidstringrequiredTransaction Id

brevomcp_loyalty_create_balance_limit#Creates a new limit on a balance definition to restrict transaction frequency or amount within a time window. Limits can constrain either the total transaction count or the total amount for credit or debit transactions. The `durationValue` and `value` fields must be greater than zero.8 params▾

Creates a new limit on a balance definition to restrict transaction frequency or amount within a time window. Limits can constrain either the total transaction count or the total amount for credit or debit transactions. The `durationValue` and `value` fields must be greater than zero.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

constraintTypestringrequiredDefines whether the limit applies to transaction count or amount.

durationUnitstringrequiredUnit of time for which the limit is applicable.

durationValueintegerrequiredNumber of time units for the balance limit. Must be greater than zero.

pidstringrequiredLoyalty Program Id

transactionTypestringrequiredSpecifies whether the limit applies to credit or debit transactions.

valueintegerrequiredMaximum allowed value for the specified constraint type. Must be greater than zero.

slidingSchedulestringoptionalDetermines if the limit resets on a rolling schedule.

brevomcp_loyalty_create_balance_order#Creates a new balance order linked to a specific balance definition and contact. An order represents a pending balance adjustment that will be processed at the specified due date. The `amount` must be non-zero and the `dueAt` timestamp must be in RFC 3339 format.8 params▾

Creates a new balance order linked to a specific balance definition and contact. An order represents a pending balance adjustment that will be processed at the specified due date. The `amount` must be non-zero and the `dueAt` timestamp must be in RFC 3339 format.

NameTypeRequiredDescription

amountnumberrequiredOrder amount (must be non-zero).

balanceDefinitionIdstringrequiredUnique identifier (UUID) of the associated balance definition.

contactIdintegerrequiredUnique identifier of the contact placing the order (must be ≥ 1).

dueAtstringrequiredRFC3339 timestamp specifying when the order is due.

pidstringrequiredLoyalty Program Id

sourcestringrequiredSpecifies the origin of the order.

expiresAtstringoptionalOptional RFC3339 timestamp defining order expiration.

metastringoptionalOptional metadata associated with the order.

brevomcp_loyalty_create_new_lp#Creates a new loyalty program for the organization. The `name` field is required and must be unique (max 128 characters). An optional `description` (max 256 characters) and arbitrary `meta` data can also be provided.4 params▾

Creates a new loyalty program for the organization. The `name` field is required and must be unique (max 128 characters). An optional `description` (max 256 characters) and arbitrary `meta` data can also be provided.

NameTypeRequiredDescription

namestringrequiredRequired name of the loyalty program (max 128 chars).

descriptionstringoptionalOptional description of the loyalty program (max 256 chars).

documentIdstringoptionalOptional unique document ID.

metastringoptionalOptional metadata related to the loyalty program.

brevomcp_loyalty_create_reward#Creates a new reward (offer) in a loyalty program. The `name` field is required (max 128 characters). Optional fields include a public-facing name, description (max 500 characters), and image URL for consumer-facing display.5 params▾

Creates a new reward (offer) in a loyalty program. The `name` field is required (max 128 characters). Optional fields include a public-facing name, description (max 500 characters), and image URL for consumer-facing display.

NameTypeRequiredDescription

namestringrequiredInternal name of the reward

pidstringrequiredLoyalty Program ID

publicDescriptionstringoptionalPublic facing description of the reward

publicImagestringoptionalURL of the public image for the reward

publicNamestringoptionalPublic facing name of the reward

brevomcp_loyalty_create_tier_for_tier_group#Creates a new tier within a tier group. The `name` (max 128 characters) and `accessConditions` (at least one required) fields are mandatory. Access conditions define the minimum balance value per balance definition required to enter this tier.6 params▾

Creates a new tier within a tier group. The `name` (max 128 characters) and `accessConditions` (at least one required) fields are mandatory. Access conditions define the minimum balance value per balance definition required to enter this tier.

NameTypeRequiredDescription

accessConditionsstringrequiredNo description.

gidstringrequiredTier group ID

namestringrequiredName of the tier to be created

pidstringrequiredLoyalty Program ID

imageRefstringoptionalImage of the tier

tierRewardsstringoptionalNo description.

brevomcp_loyalty_create_tier_group#Creates a new tier group in a loyalty program. A tier group defines an independent hierarchy of tiers with its own upgrade and downgrade strategies. The `name` field is required. Changes take effect with the next publication of the loyalty program.8 params▾

Creates a new tier group in a loyalty program. A tier group defines an independent hierarchy of tiers with its own upgrade and downgrade strategies. The `name` field is required. Changes take effect with the next publication of the loyalty program.

NameTypeRequiredDescription

namestringrequiredName of the tier group

pidstringrequiredLoyalty Program ID

downgradeSchedulestringoptionalSchedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy.

downgradeStrategystringoptionalSelect real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

metastringoptionalAdditional metadata for the tier group.

tierOrderstringoptionalOrder of the tiers in the group in ascending order

upgradeSchedulestringoptionalSchedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy.

upgradeStrategystringoptionalSelect real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

brevomcp_loyalty_create_voucher#Creates a voucher and attributes it to a specific membership. Either `contactId` or `loyaltySubscriptionId` must be provided to identify the target subscription. The `rewardId` is required.9 params▾

Creates a voucher and attributes it to a specific membership. Either `contactId` or `loyaltySubscriptionId` must be provided to identify the target subscription. The `rewardId` is required.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

rewardIdstringrequiredReward id

codestringoptionalCode generated to attribute reward to a contact

contactIdstringoptionalContact to attribute the reward

expirationDatestringoptionalReward expiration date

loyaltySubscriptionIdstringoptionalOne of contactId or loyaltySubscriptionId is required

metastringoptionalOffer meta information (key/value object)

validFromstringoptionalDate from which the voucher becomes valid. Accepts RFC 3339 or DD/MM/YYYY HH:MM AM/PM format. Converted to UTC using the organization's timezone.

valuestringoptionalValue of the selected reward config

brevomcp_loyalty_delete_balance_definition#Permanently deletes a balance definition from a loyalty program. Once deleted, the balance definition cannot be recovered. Any balances tied to this definition will no longer be usable.2 params▾

Permanently deletes a balance definition from a loyalty program. Once deleted, the balance definition cannot be recovered. Any balances tied to this definition will no longer be usable.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

pidstringrequiredLoyalty Program Id

brevomcp_loyalty_delete_balance_limit#Permanently deletes a balance limit from a balance definition. Once deleted, the limit constraint is no longer enforced on transactions.3 params▾

Permanently deletes a balance limit from a balance definition. Once deleted, the limit constraint is no longer enforced on transactions.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

blidstringrequiredBalance Limit Id

pidstringrequiredLoyalty Program Id

brevomcp_loyalty_delete_contact_members#Removes one or more members from a subscription. Provide a comma-separated list of member contact IDs via the `memberContactIds` query parameter. At least one ID is required.2 params▾

Removes one or more members from a subscription. Provide a comma-separated list of member contact IDs via the `memberContactIds` query parameter. At least one ID is required.

NameTypeRequiredDescription

memberContactIdsstringrequiredComma-separated list of member contact IDs to delete from the subscription.

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

brevomcp_loyalty_delete_contact_subscription#Removes a contact's subscription from a loyalty program. This deletes the subscription and disassociates the contact from the program. The operation cannot be undone.2 params▾

Removes a contact's subscription from a loyalty program. This deletes the subscription and disassociates the contact from the program. The operation cannot be undone.

NameTypeRequiredDescription

cidintegerrequiredContact ID.

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

brevomcp_loyalty_delete_program#Permanently deletes a loyalty program and all its associated data. This action cannot be undone. All subscriptions, balances, tiers, and rewards linked to the program will be removed.1 param▾

Permanently deletes a loyalty program and all its associated data. This action cannot be undone. All subscriptions, balances, tiers, and rewards linked to the program will be removed.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

brevomcp_loyalty_delete_tier#Deletes a tier from a loyalty program. Contacts currently assigned to the deleted tier will need to be reassigned. The changes take effect with the next publication of the loyalty program.2 params▾

Deletes a tier from a loyalty program. Contacts currently assigned to the deleted tier will need to be reassigned. The changes take effect with the next publication of the loyalty program.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

tidstringrequiredTier ID

brevomcp_loyalty_delete_tier_group#Deletes a tier group from a loyalty program. All tiers within the group are also removed. The changes take effect with the next publication of the loyalty program.2 params▾

Deletes a tier group from a loyalty program. All tiers within the group are also removed. The changes take effect with the next publication of the loyalty program.

NameTypeRequiredDescription

gidstringrequiredTier group ID

pidstringrequiredLoyalty Program ID

brevomcp_loyalty_get_balance_definition#Retrieves a single balance definition by its ID within a loyalty program. Use the `version` query parameter to fetch either the currently active or the draft configuration. Returns the full definition including expiration rules, rounding strategies, and amount constraints.3 params▾

Retrieves a single balance definition by its ID within a loyalty program. Use the `version` query parameter to fetch either the currently active or the draft configuration. Returns the full definition including expiration rules, rounding strategies, and amount constraints.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

pidstringrequiredLoyalty Program Id

versionstringoptionalVersion

brevomcp_loyalty_get_balance_definition_list#Retrieves a paginated list of balance definitions configured for a loyalty program. Balance definitions specify the currency or point unit, expiration rules, rounding strategies, and amount constraints. Use the `version` parameter to fetch either the currently active or the draft configuration.6 params▾

Retrieves a paginated list of balance definitions configured for a loyalty program. Balance definitions specify the currency or point unit, expiration rules, rounding strategies, and amount constraints. Use the `version` parameter to fetch either the currently active or the draft configuration.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program Id

limitstringoptionalLimit the number of records returned

offsetstringoptionalOffset to paginate records

sortstringoptionalSort direction

sortFieldstringoptionalField to sort by

versionstringoptionalVersion

brevomcp_loyalty_get_balance_limit#Retrieves a single balance limit by its ID for a given balance definition. Use the `version` query parameter to fetch either the currently active or the draft limit configuration.4 params▾

Retrieves a single balance limit by its ID for a given balance definition. Use the `version` query parameter to fetch either the currently active or the draft limit configuration.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

blidstringrequiredBalance Limit Id

pidstringrequiredLoyalty Program Id

versionstringoptionalVersion

brevomcp_loyalty_get_balance_programs_active_balance#Retrieves a paginated list of active (non-expired, non-consumed) balance entries for a specific contact and balance definition within a loyalty program. Both `contactId` and `balanceDefinitionId` query parameters are required.8 params▾

Retrieves a paginated list of active (non-expired, non-consumed) balance entries for a specific contact and balance definition within a loyalty program. Both `contactId` and `balanceDefinitionId` query parameters are required.

NameTypeRequiredDescription

balanceDefinitionIdstringrequiredBalance Definition ID

contactIdintegerrequiredContact ID

pidstringrequiredLoyalty Program Id

includeInternalstringoptionalInclude balances tied to internal definitions.

limitstringoptionalLimit

offsetstringoptionalOffset

sortstringoptionalSort Order

sortFieldstringoptionalSort Field

brevomcp_loyalty_get_balance_programs_transaction_history#Retrieves a paginated transaction history for a specific contact and balance definition within a loyalty program. Both `contactId` and `balanceDefinitionId` query parameters are required. Results can be filtered by transaction `status` and `transactionType`, and sorted by creation date.9 params▾

Retrieves a paginated transaction history for a specific contact and balance definition within a loyalty program. Both `contactId` and `balanceDefinitionId` query parameters are required. Results can be filtered by transaction `status` and `transactionType`, and sorted by creation date.

NameTypeRequiredDescription

balanceDefinitionIdstringrequiredBalance Definition ID

contactIdintegerrequiredContact ID

pidstringrequiredLoyalty Program Id

limitstringoptionalLimit the number of records returned

offsetstringoptionalPage number to retrieve

sortstringoptionalSort order

sortFieldstringoptionalField to sort by

statusstringoptionalTransaction status filter

transactionTypestringoptionalTransaction type filter

brevomcp_loyalty_get_code_count#Retrieves the number of available codes in a specific code pool. Code pools are used by rewards to generate unique voucher codes for attribution.2 params▾

Retrieves the number of available codes in a specific code pool. Code pools are used by rewards to generate unique voucher codes for attribution.

NameTypeRequiredDescription

cpidstringrequiredCode Pool ID

pidstringrequiredLoyalty Program ID

brevomcp_loyalty_get_contact_balances#Retrieves a paginated list of contact balances for a specific balance definition across all subscriptions in a loyalty program. The `balanceDefinitionId` query parameter is required. Results can be sorted by `updatedAt` or `value` and paginated using `limit` and `offset`.7 params▾

Retrieves a paginated list of contact balances for a specific balance definition across all subscriptions in a loyalty program. The `balanceDefinitionId` query parameter is required. Results can be sorted by `updatedAt` or `value` and paginated using `limit` and `offset`.

NameTypeRequiredDescription

balanceDefinitionIdstringrequiredBalance Definition ID (required)

pidstringrequiredLoyalty Program Id

includeInternalstringoptionalInclude balances tied to internal definitions.

limitstringoptionalLimit the number of records returned

offsetstringoptionalSkip a number of records

sortstringoptionalSort order

sortFieldstringoptionalField to sort by

brevomcp_loyalty_get_list_of_tier_groups#Retrieves all tier groups configured for a loyalty program. Each tier group defines an independent hierarchy of tiers with its own upgrade and downgrade strategies. Use the `version` parameter to fetch either the active or draft configuration.2 params▾

Retrieves all tier groups configured for a loyalty program. Each tier group defines an independent hierarchy of tiers with its own upgrade and downgrade strategies. Use the `version` parameter to fetch either the active or draft configuration.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

versionstringoptionalSelect 'active' to retrieve list of all tier groups which are live for clients. Select draft to retrieve list of all non deleted tier groups.

brevomcp_loyalty_get_lp_list#Retrieves a paginated list of loyalty programs for the organization. Results can be sorted by name, creation date, or last update date. Use `limit` and `offset` to paginate through the results. The maximum page size is 500 items.4 params▾

Retrieves a paginated list of loyalty programs for the organization. Results can be sorted by name, creation date, or last update date. Use `limit` and `offset` to paginate through the results. The maximum page size is 500 items.

NameTypeRequiredDescription

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort order

sort_fieldstringoptionalSort documents by field

brevomcp_loyalty_get_offer_programs_offers#Retrieves a paginated list of rewards (offers) configured for a loyalty program. Results can be filtered by state and version (draft or active). The default page size is 25 with a maximum of 100 items per page.5 params▾

Retrieves a paginated list of rewards (offers) configured for a loyalty program. Results can be filtered by state and version (draft or active). The default page size is 25 with a maximum of 100 items per page.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

limitstringoptionalPage size

offsetstringoptionalPagination offset

statestringoptionalState of the reward

versionstringoptionalVersion

brevomcp_loyalty_get_offer_programs_rewards_by_rid#Retrieves the full details of a reward by its ID, including configuration, rules, code generation settings, limits, products, and attribution/redemption counters. Use the `version` query parameter to fetch either the active or draft version.3 params▾

Retrieves the full details of a reward by its ID, including configuration, rules, code generation settings, limits, products, and attribution/redemption counters. Use the `version` query parameter to fetch either the active or draft version.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

ridstringrequiredReward ID

versionstringoptionalVersion

brevomcp_loyalty_get_offer_programs_vouchers#Retrieves a paginated list of vouchers attributed to a specific contact within a loyalty program. The `contactId` query parameter is required (must be >= 1). Results can be filtered by `rewardId` or metadata key/value, sorted by `updatedAt` or `createdAt`, with a maximum of 500 items per page.8 params▾

Retrieves a paginated list of vouchers attributed to a specific contact within a loyalty program. The `contactId` query parameter is required (must be >= 1). Results can be filtered by `rewardId` or metadata key/value, sorted by `updatedAt` or `createdAt`, with a maximum of 500 items per page.

NameTypeRequiredDescription

contactIdintegerrequiredContact ID

pidstringrequiredLoyalty Program ID

limitstringoptionalPage size

metadata_key_valuestringoptionalMetadata value for a Key filter

offsetstringoptionalPagination offset

rewardIdstringoptionalReward ID

sortstringoptionalSort order

sortFieldstringoptionalSort field

brevomcp_loyalty_get_parameter_subscription_info#Retrieves comprehensive subscription data for a contact, including balances, tier assignments, attributed rewards, and subscription members. At least one of `contactId` or `loyaltySubscriptionId` must be provided to identify the subscription.5 params▾

Retrieves comprehensive subscription data for a contact, including balances, tier assignments, attributed rewards, and subscription members. At least one of `contactId` or `loyaltySubscriptionId` must be provided to identify the subscription.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

contactIdstringoptionalThe contact ID to filter by.

includeInternalstringoptionalInclude balances tied to internal definitions.

loyaltySubscriptionIdstringoptionalThe loyalty subscription ID to filter by.

paramsstringoptionalA list of filter parameters for querying the subscription info.

brevomcp_loyalty_get_program_info#Retrieves the full details of a single loyalty program by its ID, including its current state, metadata, subscription pool configuration, and timestamps.1 param▾

Retrieves the full details of a single loyalty program by its ID, including its current state, metadata, subscription pool configuration, and timestamps.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

brevomcp_loyalty_get_program_tier#Retrieves all tiers configured for a loyalty program across all tier groups. Use the `version` parameter to fetch either the currently active tiers or the draft configuration with pending changes.2 params▾

Retrieves all tiers configured for a loyalty program across all tier groups. Use the `version` parameter to fetch either the currently active tiers or the draft configuration with pending changes.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

versionstringoptionalSelect 'active' to retrieve list of all tiers which are live for clients. Select draft to retrieve list of all non deleted tiers.

brevomcp_loyalty_get_subscription_balances#Retrieves the aggregate balances for a contact's subscription within a loyalty program. Returns the total balance value per balance definition. Use the `includeInternal` parameter to also include balances tied to internal definitions.3 params▾

Retrieves the aggregate balances for a contact's subscription within a loyalty program. Returns the total balance value per balance definition. Use the `includeInternal` parameter to also include balances tied to internal definitions.

NameTypeRequiredDescription

cidstringrequiredContact ID

pidstringrequiredLoyalty Program Id

includeInternalstringoptionalInclude balances tied to internal definitions.

brevomcp_loyalty_get_tier_group#Retrieves the full details of a tier group by its ID, including name, upgrade and downgrade strategies, tier ordering, and schedule configurations. Use the `version` parameter to fetch either the active or draft configuration.3 params▾

Retrieves the full details of a tier group by its ID, including name, upgrade and downgrade strategies, tier ordering, and schedule configurations. Use the `version` parameter to fetch either the active or draft configuration.

NameTypeRequiredDescription

gidstringrequiredTier group ID

pidstringrequiredLoyalty Program ID

versionstringoptionalSelect active to retrieve active version of tier group. Select draft to retrieve latest changes in tier group.

brevomcp_loyalty_partially_update_loyalty_program#Partially updates a loyalty program. Only the fields provided in the request body are modified; omitted fields remain unchanged. Supports updating the name (max 128 characters), description (max 256 characters), metadata, and birthday attribute.6 params▾

Partially updates a loyalty program. Only the fields provided in the request body are modified; omitted fields remain unchanged. Supports updating the name (max 128 characters), description (max 256 characters), metadata, and birthday attribute.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

birthdayAttributestringoptionalContact attribute name used for birthday tracking (max 128 characters).

descriptionstringoptionalLoyalty program description (max 256 characters).

documentIdstringoptionalOptional document identifier.

metastringoptionalLoyalty program metadata.

namestringoptionalLoyalty program name (max 128 characters).

brevomcp_loyalty_post_balance_programs_balance_definitions#Creates a new balance definition within a loyalty program. A balance definition specifies the unit of measurement (points or currency), expiration rules, rounding strategies, and amount constraints.17 params▾

Creates a new balance definition within a loyalty program. A balance definition specifies the unit of measurement (points or currency), expiration rules, rounding strategies, and amount constraints.

NameTypeRequiredDescription

namestringrequiredName of the balance definition.

pidstringrequiredLoyalty Program Id

unitstringrequiredUnit of balance measurement.

balanceAvailabilityDurationModifierstringoptionalDefines when the balance expires within the selected duration.

balanceAvailabilityDurationUnitstringoptionalUnit of time for balance validity.

balanceAvailabilityDurationValuestringoptionalNumber of time units before the balance expires.

balanceExpirationDatestringoptionalFixed expiration date (`dd/mm` format) as an alternative to duration-based expiry. Cannot be combined with duration-based availability fields.

balanceOptionAmountOvertakingStrategystringoptionalDefines whether partial credit is allowed when reaching max balance.

balanceOptionCreditRoundingstringoptionalDefines rounding strategy for credit transactions.

balanceOptionDebitRoundingstringoptionalDefines rounding strategy for debit transactions.

descriptionstringoptionalShort description of the balance definition.

imageRefstringoptionalURL of an optional image reference.

maxAmountstringoptionalMaximum allowable balance amount.

maxCreditAmountLimitstringoptionalMaximum credit allowed per operation.

maxDebitAmountLimitstringoptionalMaximum debit allowed per operation.

metastringoptionalAdditional metadata for the balance definition.

minAmountstringoptionalMinimum allowable balance amount.

brevomcp_loyalty_post_balance_programs_subscriptions_balances#Creates a new balance entry for a contact's subscription, linked to a specific balance definition. The contact must have an active subscription in the loyalty program. The `balanceDefinitionId` field is required in the request body.3 params▾

Creates a new balance entry for a contact's subscription, linked to a specific balance definition. The contact must have an active subscription in the loyalty program. The `balanceDefinitionId` field is required in the request body.

NameTypeRequiredDescription

balanceDefinitionIdstringrequiredUnique identifier (UUID) of the balance definition associated with the new balance.

cidstringrequiredContact Id

pidstringrequiredLoyalty Program Id

brevomcp_loyalty_publish_loyalty_program#Publishes the current draft version of a loyalty program, making all pending changes (balance definitions, tiers, tier groups, rewards) live. After publication, the draft and active versions become identical until new changes are made.1 param▾

Publishes the current draft version of a loyalty program, making all pending changes (balance definitions, tiers, tier groups, rewards) live. After publication, the draft and active versions become identical until new changes are made.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

brevomcp_loyalty_redeem_voucher#Creates a redemption request for a voucher. The voucher can be identified either by `code` or by `attributedRewardId`. A `contactId` or `loyaltySubscriptionId` must be provided to identify the subscriber. The redemption is created in a pending state unless `autoComplete` is true.10 params▾

Creates a redemption request for a voucher. The voucher can be identified either by `code` or by `attributedRewardId`. A `contactId` or `loyaltySubscriptionId` must be provided to identify the subscriber. The redemption is created in a pending state unless `autoComplete` is true.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

attributedRewardIdstringoptionalUnique identifier for the attributed reward

autoCompletestringoptionalWhether the redemption should be automatically completed

codestringoptionalRedemption code for the reward

contactIdstringoptionalUnique identifier for the contact

loyaltySubscriptionIdstringoptionalIdentifier for the loyalty subscription

metastringoptionalAdditional metadata associated with the redeem request

orderstringoptionalOrder details for the redemption

rewardIdstringoptionalUnique identifier for the reward

ttlstringoptionalTime to live in seconds for the redemption request

brevomcp_loyalty_revoke_vouchers#Revokes one or more attributed vouchers by their IDs. Provide a comma-separated list of attributed reward IDs via the `attributedRewardIds` query parameter. Revoked vouchers can no longer be redeemed.2 params▾

Revokes one or more attributed vouchers by their IDs. Provide a comma-separated list of attributed reward IDs via the `attributedRewardIds` query parameter. Revoked vouchers can no longer be redeemed.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

attributedRewardIdsstringoptionalReward Attribution IDs (comma seperated)

brevomcp_loyalty_subscribe_member_to_a_subscription#Adds one or more members to an existing subscription. Either `contactId` or `loyaltySubscriptionId` must be provided to identify the target subscription. The `memberContactIds` array must contain at least one member ID (each >= 1). The subscription owner cannot be added as a member.4 params▾

Adds one or more members to an existing subscription. Either `contactId` or `loyaltySubscriptionId` must be provided to identify the target subscription. The `memberContactIds` array must contain at least one member ID (each >= 1). The subscription owner cannot be added as a member.

NameTypeRequiredDescription

memberContactIdsstringrequiredRequired, each item must be greater than or equal to 1

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

contactIdstringoptionalRequired if LoyaltySubscriptionId is not provided, must be greater than 0

loyaltySubscriptionIdstringoptionalRequired if ContactId is not provided, max length 64

brevomcp_loyalty_subscribe_to_loyalty_program#Creates a new subscription for a contact in a loyalty program. The `contactId` field is required and must be greater than zero. An optional `loyaltySubscriptionId` (max 64 characters) can be provided as a custom identifier. The `creationDate`, if provided, must be in the past (ISO 8601 format).5 params▾

Creates a new subscription for a contact in a loyalty program. The `contactId` field is required and must be greater than zero. An optional `loyaltySubscriptionId` (max 64 characters) can be provided as a custom identifier. The `creationDate`, if provided, must be in the past (ISO 8601 format).

NameTypeRequiredDescription

contactIdintegerrequiredRequired contact ID; must be greater than 0.

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

creationDatestringoptionalOptional creation date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.ffffff+HH:MM). Must be in the past.

loyaltySubscriptionIdstringoptionalOptional subscription ID (max length 64).

metastringoptionalOptional metadata associated with the subscription.

brevomcp_loyalty_update_balance_definition#Replaces an existing balance definition with the provided data. This is a full replacement (PUT), not a partial update; all fields in the payload are applied. The `name` and `unit` fields are required.18 params▾

Replaces an existing balance definition with the provided data. This is a full replacement (PUT), not a partial update; all fields in the payload are applied. The `name` and `unit` fields are required.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

namestringrequiredName of the balance definition.

pidstringrequiredLoyalty Program Id

unitstringrequiredUnit of balance measurement.

balanceAvailabilityDurationModifierstringoptionalDefines when the balance expires within the selected duration.

balanceAvailabilityDurationUnitstringoptionalUnit of time for balance validity.

balanceAvailabilityDurationValuestringoptionalNumber of time units before the balance expires.

balanceExpirationDatestringoptionalExpiration date (`dd/mm` format) or empty if not applicable.

balanceOptionAmountOvertakingStrategystringoptionalDefines whether partial credit is allowed when reaching max balance.

balanceOptionCreditRoundingstringoptionalRounding strategy for credit transactions.

balanceOptionDebitRoundingstringoptionalRounding strategy for debit transactions.

descriptionstringoptionalShort description of the balance definition.

imageRefstringoptionalURL of an optional image reference.

maxAmountstringoptionalMaximum allowable balance amount.

maxCreditAmountLimitstringoptionalMaximum credit allowed per operation.

maxDebitAmountLimitstringoptionalMaximum debit allowed per operation.

metastringoptionalOptional metadata for the balance definition.

minAmountstringoptionalMinimum allowable balance amount.

brevomcp_loyalty_update_balance_limit#Replaces an existing balance limit with the provided data. This is a full replacement (PUT); all fields in the payload are applied. The `durationValue` and `value` fields must be greater than zero.9 params▾

Replaces an existing balance limit with the provided data. This is a full replacement (PUT); all fields in the payload are applied. The `durationValue` and `value` fields must be greater than zero.

NameTypeRequiredDescription

bdidstringrequiredBalance Definition Id

blidstringrequiredBalance Limit Id

constraintTypestringrequiredDefines whether the limit applies to transaction count or amount.

durationUnitstringrequiredUnit of time for which the limit is applicable.

durationValueintegerrequiredNumber of time units for the balance limit. Must be greater than zero.

pidstringrequiredLoyalty Program Id

transactionTypestringrequiredSpecifies whether the limit applies to credit or debit transactions.

valueintegerrequiredMaximum allowed value for the specified constraint type. Must be greater than zero.

slidingSchedulestringoptionalDetermines if the limit resets on a rolling schedule.

brevomcp_loyalty_update_loyalty_program#Replaces a loyalty program with the provided data. This is a full replacement (PUT); all fields in the payload are applied. The `name` field is required (max 128 characters). The program name must be unique within the organization.4 params▾

Replaces a loyalty program with the provided data. This is a full replacement (PUT); all fields in the payload are applied. The `name` field is required (max 128 characters). The program name must be unique within the organization.

NameTypeRequiredDescription

namestringrequiredLoyalty Program name

pidstringrequiredLoyalty Program ID. A unique identifier for the loyalty program.

descriptionstringoptionalLoyalty Program description

metastringoptionalLoyalty Program meta data

brevomcp_loyalty_update_tier#Replaces an existing tier's configuration with the provided data. This is a full replacement (PUT); the `name`, `accessConditions`, and `tierRewards` fields are all required. Changes take effect with the next publication of the loyalty program.6 params▾

Replaces an existing tier's configuration with the provided data. This is a full replacement (PUT); the `name`, `accessConditions`, and `tierRewards` fields are all required. Changes take effect with the next publication of the loyalty program.

NameTypeRequiredDescription

accessConditionsstringrequiredNo description.

namestringrequiredName of the tier to be created

pidstringrequiredLoyalty Program ID

tidstringrequiredTier ID

tierRewardsstringrequiredNo description.

imageRefstringoptionalImage of the tier

brevomcp_loyalty_update_tier_group#Replaces a tier group's configuration with the provided data. This is a full replacement (PUT); all required fields must be provided. The changes take effect with the next publication of the loyalty program.7 params▾

Replaces a tier group's configuration with the provided data. This is a full replacement (PUT); all required fields must be provided. The changes take effect with the next publication of the loyalty program.

NameTypeRequiredDescription

downgradeStrategystringrequiredSelect real_time to downgrade tier on real time balance updates. Select membership_anniversary to downgrade tier on subscription anniversary. Select tier_anniversary to downgrade tier on tier anniversary.

gidstringrequiredTier group ID

namestringrequiredName of the tier group

pidstringrequiredLoyalty Program ID

tierOrderstringrequiredOrder of the tiers in the group in ascending order

upgradeStrategystringrequiredSelect real_time to upgrade tier on real time balance updates. Select membership_anniversary to upgrade tier on subscription anniversary. Select tier_anniversary to upgrade tier on tier anniversary.

metastringoptionalAdditional metadata for the tier group.

brevomcp_loyalty_validate_reward#Validates whether a reward can be redeemed for a given contact or subscription. The voucher can be identified either by `code` or by `attributedRewardId`. Returns an `authorize` boolean indicating whether the redemption is permitted based on the reward's rules and limits.7 params▾

Validates whether a reward can be redeemed for a given contact or subscription. The voucher can be identified either by `code` or by `attributedRewardId`. Returns an `authorize` boolean indicating whether the redemption is permitted based on the reward's rules and limits.

NameTypeRequiredDescription

pidstringrequiredLoyalty Program ID

attributedRewardIdstringoptionalUnique identifier for the attributed reward

codestringoptionalValidation code for the reward

contactIdstringoptionalUnique identifier for the contact

loyaltySubscriptionIdstringoptionalIdentifier for the loyalty subscription

pointOfSellIdstringoptionalIdentifier for the point of sale

rewardIdstringoptionalUnique identifier for the reward

brevomcp_notes_delete_crm_notes_by_id#Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals. The authenticated user must have delete permission for the entities linked to the note.1 param▾

Permanently delete a CRM note by its identifier. This removes the note and unlinks it from any associated contacts, companies, or deals. The authenticated user must have delete permission for the entities linked to the note.

NameTypeRequiredDescription

idstringrequiredNote ID to delete

brevomcp_notes_get_crm_notes#Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 notes per page. When filtering by entity IDs, the `entity` parameter must also be specified.7 params▾

Retrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range. Results are sorted by creation date in descending order by default, with a default limit of 50 notes per page. When filtering by entity IDs, the `entity` parameter must also be specified.

NameTypeRequiredDescription

dateFromstringoptionalStart of date range filter (timestamp in milliseconds)

dateTostringoptionalEnd of date range filter (timestamp in milliseconds)

entitystringoptionalFilter by note entity type. Required when `entityIds` is provided.

entityIdsstringoptionalFilter by note entity IDs (comma-separated). The `entity` parameter must also be provided when using this filter. For contacts, provide numeric IDs; for companies and deals, provide object IDs.

limitstringoptionalNumber of documents per page. Must be greater than 0.

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order. Default order is descending by creation date if `sort` is not passed.

brevomcp_notes_get_crm_notes_by_id#Retrieve the full details of a single CRM note by its identifier. The response includes the note's text content, creation and update timestamps, author information, and any associated contacts, companies, or deals.1 param▾

Retrieve the full details of a single CRM note by its identifier. The response includes the note's text content, creation and update timestamps, author information, and any associated contacts, companies, or deals.

NameTypeRequiredDescription

idstringrequiredNote ID to retrieve

brevomcp_notes_patch_crm_notes_by_id#Update an existing CRM note's text content and its associations with contacts, companies, or deals. You can modify the note text, update the linked entities, or toggle the pinned status. At least one field must be provided for the update.6 params▾

Update an existing CRM note's text content and its associations with contacts, companies, or deals. You can modify the note text, update the linked entities, or toggle the pinned status. At least one field must be provided for the update.

NameTypeRequiredDescription

idstringrequiredNote ID to update

textstringrequiredText content of the note. Supports HTML content. Must not be empty and cannot exceed 10,000 characters (excluding HTML tags and line breaks).

companyIdsstringoptionalCompany IDs to link to the note

contactIdsstringoptionalContact IDs to link to the note. For creation, at least one entity (contact, company, or deal) must be provided.

dealIdsstringoptionalDeal IDs to link to the note

isPinnedstringoptionalWhether to pin or unpin the note. Only applicable when updating a note.

brevomcp_notes_post_crm_notes#Create a new CRM note and associate it with at least one contact, company, or deal. The note text content is required and cannot be empty. The text supports HTML content but must not exceed 10,000 characters (excluding HTML tags and line breaks).5 params▾

Create a new CRM note and associate it with at least one contact, company, or deal. The note text content is required and cannot be empty. The text supports HTML content but must not exceed 10,000 characters (excluding HTML tags and line breaks).

NameTypeRequiredDescription

textstringrequiredText content of the note. Supports HTML content. Must not be empty and cannot exceed 10,000 characters (excluding HTML tags and line breaks).

companyIdsstringoptionalCompany IDs to link to the note

contactIdsstringoptionalContact IDs to link to the note. For creation, at least one entity (contact, company, or deal) must be provided.

dealIdsstringoptionalDeal IDs to link to the note

isPinnedstringoptionalWhether to pin or unpin the note. Only applicable when updating a note.

brevomcp_objects_batch_delete_object_records#Use this endpoint to delete multiple object records of the same object-type in one request. The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.2 params▾

Use this endpoint to delete multiple object records of the same object-type in one request. The request is accepted and processed asynchronously. You can track the status of the deletion process using the returned **processId**.

NameTypeRequiredDescription

object_typestringrequiredObject type for the records to delete

identifiersstringoptionalEither `ids` or `ext_ids` must be provided, but not both in the same request.

brevomcp_objects_getrecords#This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.5 params▾

This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. **Note**: Contact as object type is not supported in this endpoint.

NameTypeRequiredDescription

limitintegerrequiredNumber of records returned per page

object_typestringrequiredObject type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint.

page_numintegerrequiredPage number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.

associationstringoptionalWhether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.

sortstringoptionalSort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.

brevomcp_objects_upsertrecords#This API allows bulk upsert of object records in a single request. Each object record may include attributes, identifiers, and associations.2 params▾

This API allows bulk upsert of object records in a single request. Each object record may include attributes, identifiers, and associations.

NameTypeRequiredDescription

object_typestringrequiredObject type for the records to upsert. Must be a previously created custom object type. Only lowercase alphanumeric characters and underscores are allowed (max 32 characters).

recordsstringrequiredList of object records to be upsert. Each record can have attributes, identifiers, and associations.

brevomcp_payments_create_payment_request#Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders.6 params▾

Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders.

NameTypeRequiredDescription

cartstringrequiredSpecify the payment currency and amount.

contactIdintegerrequiredBrevo ID of the contact requested to pay.

referencestringrequiredReference of the payment request, it will appear on the payment page.

configurationstringoptionalOptional. Redirect contact to a custom success page once payment is successful. If empty the default Brevo page will be displayed once a payment is validated

descriptionstringoptionalDescription of payment request.

notificationstringoptionalOptional. Use this object if you want to let Brevo send an email to the contact, with the payment request URL. If empty, no notifications (message and reminders) will be sent.

brevomcp_payments_delete_payment_request#Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.1 param▾

Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a `404` error if no payment request matches the provided ID, and a `403` error if Brevo Payments is not activated or the account is not validated.

NameTypeRequiredDescription

idstringrequiredID of the payment request.

brevomcp_payments_get_payment_request#Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent.1 param▾

Retrieve the details of a specific payment request by its ID. The response includes the reference, status (created, sent, reminderSent, or paid), cart details, notification configuration, contact ID, and the number of reminders sent.

NameTypeRequiredDescription

idstringrequiredId of the payment Request

brevomcp_pipelines_get_crm_pipeline_details#This endpoint is deprecated. Use `/crm/pipeline/details/{pipelineID}` or `/crm/pipeline/details/all` instead to retrieve pipeline stages for a specific pipeline or all pipelines respectively.0 params▾

This endpoint is deprecated. Use `/crm/pipeline/details/{pipelineID}` or `/crm/pipeline/details/all` instead to retrieve pipeline stages for a specific pipeline or all pipelines respectively.

brevomcp_pipelines_get_crm_pipeline_details_all#Retrieve the list of all deal pipelines configured for your account, including each pipeline's stages. Each stage includes its name, ID, and win probability. If no pipelines have been configured yet, they are automatically initialized before being returned.0 params▾

Retrieve the list of all deal pipelines configured for your account, including each pipeline's stages. Each stage includes its name, ID, and win probability. If no pipelines have been configured yet, they are automatically initialized before being returned.

brevomcp_pipelines_get_crm_pipeline_details_by_pipeline_id#Retrieve the details of a specific deal pipeline by its identifier, including its stages and their win probabilities. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals. If the pipeline ID is not found, a 400 error is returned.1 param▾

Retrieve the details of a specific deal pipeline by its identifier, including its stages and their win probabilities. Use this endpoint to obtain the pipeline and stage IDs needed when creating or updating deals. If the pipeline ID is not found, a 400 error is returned.

NameTypeRequiredDescription

pipelineIDstringrequiredID of the pipeline to retrieve

brevomcp_processes_get_process#Retrieves detailed information about a specific background process.1 param▾

Retrieves detailed information about a specific background process.

NameTypeRequiredDescription

processIdintegerrequiredId of the process

brevomcp_processes_get_processes#Retrieves a list of background processes from your Brevo account with filtering and pagination.3 params▾

Retrieves a list of background processes from your Brevo account with filtering and pagination.

NameTypeRequiredDescription

limitstringoptionalNumber limitation for the result returned

offsetstringoptionalBeginning point in the list to retrieve from.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_products_create_product_alert#Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`.3 params▾

Register a contact to receive an alert for a specific product event, such as `back_in_stock`. At least one contact identifier (`ext_id`, `email`, or `sms`) must be provided; when multiple are given, priority is `ext_id` > `email` > `sms`.

NameTypeRequiredDescription

idstringrequiredProduct ID

typestringrequiredAlert type

contactIdentifiersstringoptionalNo description.

brevomcp_products_create_update_batch_products#Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit).2 params▾

Create or update multiple ecommerce products in a single request. The `products` array accepts up to 100 product objects for creation (or up to 1000 when `updateEnabled` is `true` and the account has an increased limit).

NameTypeRequiredDescription

productsstringrequiredarray of products objects

updateEnabledstringoptionalFacilitate to update the existing products in the same request (updateEnabled = true)

brevomcp_products_create_update_product#Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned.16 params▾

Create a new ecommerce product or update an existing one, identified by the mandatory `id` field. When `updateEnabled` is `false` (the default), the endpoint inserts a new product and returns `201`; if the product ID already exists, a `400` error is returned.

NameTypeRequiredDescription

idstringrequiredProduct ID for which you requested the details

alternativePricestringoptionalAlternative price of the product

brandstringoptionalBrand of the product

categoriesstringoptionalCategory ID-s of the product

deletedAtstringoptionalUTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database

descriptionstringoptionalDescription of the product

imageUrlstringoptionalAbsolute URL to the cover image of the product

isDeletedstringoptionalproduct deleted from the shop's database

metaInfostringoptionalMeta data of product such as description, vendor, producer, stock level. Maximum 20 keys allowed. Each key name must be at most 50 characters, and each string value must be at most 1000 characters. The cumulative size of all metaInfo must not exceed approximately 1000 KB.

namestringoptionalMandatory in case of creation. Name of the product, as displayed in the shop

parentIdstringoptionalParent product id of the product

pricestringoptionalPrice of the product

skustringoptionalProduct identifier from the shop

stockstringoptionalCurrent stock value of the product from the shop's database

updateEnabledstringoptionalFacilitate to update the existing product in the same request (updateEnabled = true)

urlstringoptionalURL to the product

brevomcp_products_get_product_info#Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status.1 param▾

Retrieve the full details of a single ecommerce product by its unique ID. The response includes the product name, price, SKU, URL, image URLs (original and thumbnails), categories, stock level, meta information, creation and modification timestamps, and deletion status.

NameTypeRequiredDescription

idstringrequiredProduct ID

brevomcp_products_get_products#Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status.22 params▾

Retrieve a paginated list of all ecommerce products stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by product IDs, name (minimum 3 characters), price range, category IDs, modification date, creation date, or deletion status.

NameTypeRequiredDescription

alternativePrice_eqstringoptionalAlternative price filter for products equals to particular amount

alternativePrice_gtstringoptionalAlternative price filter for products greater than particular amount

alternativePrice_gtestringoptionalAlternative price filter for products greater than and equals to particular amount

alternativePrice_ltstringoptionalAlternative price filter for products less than particular amount

alternativePrice_ltestringoptionalAlternative price filter for products less than and equals to particular amount

alternativePrice_nestringoptionalAlternative price filter for products not equals to particular amount

categoriesstringoptionalFilter by categories ids

createdSincestringoptionalFilter (urlencoded) the products created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

idsstringoptionalFilter by product ids

isDeletedstringoptionalFilter products by their deletion status. If `false` is passed, only products that are not deleted will be returned.

limitstringoptionalNumber of documents per page

modifiedSincestringoptionalFilter (urlencoded) the products modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

namestringoptionalFilter by product name, minimum 3 characters should be present for search.

offsetstringoptionalIndex of the first document in the page

price_eqstringoptionalPrice filter for products equals to particular amount

price_gtstringoptionalPrice filter for products greater than particular amount

price_gtestringoptionalPrice filter for products greater than and equals to particular amount

price_ltstringoptionalPrice filter for products less than particular amount

price_ltestringoptionalPrice filter for products less than and equals to particular amount

price_nestringoptionalPrice filter for products not equals to particular amount

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

sortByFieldstringoptionalSort the results by a specific field. Default sort field is `created_at` when not passed.

brevomcp_segments_get_segments#Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.3 params▾

Retrieve all contact segments defined in your Brevo account with support for pagination and sorting. Results default to 10 segments per page (maximum 50) sorted in descending order of creation. Each segment includes its ID, name, category name, and last update timestamp.

NameTypeRequiredDescription

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_senders_create_sender#Creates a new email sender in your Brevo account. Both `name` and `email` are required fields.3 params▾

Creates a new email sender in your Brevo account. Both `name` and `email` are required fields.

NameTypeRequiredDescription

emailstringrequiredFrom email to use for the sender. A verification email will be sent to this address.

namestringrequiredFrom Name to use for the sender

ipsstringoptionalMandatory in case of dedicated IP. IPs to associate to the sender. Not required for standard accounts.

brevomcp_senders_delete_sender#Deletes an email sender from your Brevo account. The sender ID must be a valid positive integer.1 param▾

Deletes an email sender from your Brevo account. The sender ID must be a valid positive integer.

NameTypeRequiredDescription

senderIdintegerrequiredId of the sender

brevomcp_senders_get_senders#Retrieves a list of all email senders from your Brevo account with optional filtering.2 params▾

Retrieves a list of all email senders from your Brevo account with optional filtering.

NameTypeRequiredDescription

domainstringoptionalFilter your senders for a specific domain

ipstringoptionalFilter your senders for a specific ip. Available for dedicated IP usage only

brevomcp_senders_update_sender#Updates an existing email sender's configuration. At least one field (name, email, or ips) must be provided.4 params▾

Updates an existing email sender's configuration. At least one field (name, email, or ips) must be provided.

NameTypeRequiredDescription

senderIdintegerrequiredId of the sender

emailstringoptionalFrom Email to update the sender

ipsstringoptionalOnly in case of dedicated IP. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts.

namestringoptionalFrom Name to update the sender

brevomcp_senders_validate_sender_by_otp#Validates a sender using the OTP (One-Time Password) received via email.2 params▾

Validates a sender using the OTP (One-Time Password) received via email.

NameTypeRequiredDescription

otpintegerrequired6 digit OTP received on email

senderIdintegerrequiredId of the sender

brevomcp_sms_campaigns_create_sms_campaign#Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment.8 params▾

Create a new SMS campaign with the required name, sender, and content fields. The sender name is limited to 11 alphanumeric characters or 15 numeric characters, and the content should stay within 160 characters per SMS segment.

NameTypeRequiredDescription

contentstringrequiredContent of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS.

namestringrequiredName of the campaign

senderstringrequiredName of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters

organisationPrefixstringoptionalA recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

recipientsstringoptionalNo description.

scheduledAtstringoptionalUTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

unicodeEnabledstringoptionalFormat of the message. It indicates whether the content should be treated as unicode or not.

unsubscribeInstructionstringoptionalInstructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.

brevomcp_sms_campaigns_delete_sms_campaign#Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.1 param▾

Delete an SMS campaign by its campaign ID. Only campaigns that have not been scheduled or sent can be deleted; attempting to delete a campaign that is queued, in process, or has been sent with recipients will return a 403 permission denied error.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the SMS campaign

brevomcp_sms_campaigns_get_sms_campaign#Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags.1 param▾

Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the SMS campaign

brevomcp_sms_campaigns_get_sms_campaigns#Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page.6 params▾

Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page.

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. `endDate` must not be in the future.

limitstringoptionalNumber of documents per page

offsetstringoptionalBeginning point in the list to retrieve from.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. `startDate` must not be in the future.

statusstringoptionalStatus of campaign.

brevomcp_sms_campaigns_request_sms_recipient_export#Export the recipients of a sent SMS campaign as an asynchronous process, filtered by recipient type (e.g. delivered, answered, hardBounces). The recipientsType field is required and determines which subset of recipients to export.3 params▾

Export the recipients of a sent SMS campaign as an asynchronous process, filtered by recipient type (e.g. delivered, answered, hardBounces). The recipientsType field is required and determines which subset of recipients to export.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

recipientsTypestringrequiredFilter the recipients based on how they interacted with the campaign

notifyURLstringoptionalURL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

brevomcp_sms_campaigns_send_sms_campaign_now#Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account's SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned.1 param▾

Send an existing SMS campaign immediately by scheduling it for the current time. The system verifies your account's SMS credit balance before dispatching; if credits are insufficient or the remaining credit is less than the number of recipients, a 402 error is returned.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

brevomcp_sms_campaigns_send_sms_report#Send a PDF report of an SMS campaign to the specified email addresses. The report includes campaign statistics such as deliveries, bounces, answered, and unsubscriptions. The email recipients list supports a maximum of 99 addresses, and a custom body text is required.3 params▾

Send a PDF report of an SMS campaign to the specified email addresses. The report includes campaign statistics such as deliveries, bounces, answered, and unsubscriptions. The email recipients list supports a maximum of 99 addresses, and a custom body text is required.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

emailstringrequiredCustom attributes for the report email.

languagestringoptionalLanguage of email content for campaign report sending.

brevomcp_sms_campaigns_send_test_sms#Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).2 params▾

Send a test SMS to a specified phone number to preview the campaign before sending it to all recipients. The phone number must belong to one of your existing contacts in your Brevo account and must not be blacklisted. The number should include the country code (e.g. 33689965433).

NameTypeRequiredDescription

campaignIdintegerrequiredId of the SMS campaign

phoneNumberstringrequiredMobile number of the recipient with the country code. This number must belong to one of your contacts in Brevo account and must not be blacklisted. The number must contain between 6 and 18 digits including the country code (e.g. 33689965433).

brevomcp_sms_campaigns_update_sms_campaign#Update an existing SMS campaign's properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update.9 params▾

Update an existing SMS campaign's properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions. The request body must contain at least one valid field to update.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the SMS campaign

contentstringoptionalContent of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS

namestringoptionalName of the campaign

organisationPrefixstringoptionalA recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

recipientsstringoptionalNo description.

scheduledAtstringoptionalUTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.

senderstringoptionalName of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters

unicodeEnabledstringoptionalFormat of the message. It indicates whether the content should be treated as unicode or not.

unsubscribeInstructionstringoptionalInstructions to unsubscribe from future communications. Recommended by U.S. carriers. Must include STOP keyword. This will be added as instructions after the end of message content. Prefer verifying maximum length of 160 characters including this instructions in message content to avoid multiple sending of same sms.

brevomcp_sms_campaigns_update_sms_campaign_status#Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values are: suspended, archive, darchive, sent, queued, replicate, replicateTemplate, and draft. The replicateTemplate status is only available for template type campaigns.2 params▾

Update the status of an SMS campaign, such as suspending, archiving, or replicating it. Available status values are: suspended, archive, darchive, sent, queued, replicate, replicateTemplate, and draft. The replicateTemplate status is only available for template type campaigns.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

statusstringoptionalNote:- replicateTemplate status will be available only for template type campaigns.

brevomcp_tasks_delete_crm_tasks_by_id#Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.1 param▾

Permanently delete a CRM task by its identifier. This removes the task and cancels any associated reminders. The requesting user must be the task assignee or have manage permission on tasks.

NameTypeRequiredDescription

idstringrequiredTask ID

brevomcp_tasks_get_crm_tasks#Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.13 params▾

Retrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies). Results are sorted by creation date in descending order by default, with a default limit of 50 tasks per page.

NameTypeRequiredDescription

dateFromstringoptionaldateFrom to date range filter type (timestamp in milliseconds)

dateTostringoptionaldateTo to date range filter type (timestamp in milliseconds)

filter_assignTostringoptionalFilter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.

filter_companiesstringoptionalFilter by companies ids

filter_contactsstringoptionalFilter by contact ids

filter_datestringoptionalFilter by date

filter_dealsstringoptionalFilter by deals ids

filter_statusstringoptionalFilter by task status

filter_typestringoptionalFilter by task type (ID)

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

sortstringoptionalSort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

sortBystringoptionalThe field used to sort field names.

brevomcp_tasks_get_crm_tasks_by_id#Retrieve the full details of a single CRM task by its identifier. The response includes the task's name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.1 param▾

Retrieve the full details of a single CRM task by its identifier. The response includes the task's name, type, status, due date, duration, notes, assignee, reminder settings, and linked contacts, companies, or deals.

NameTypeRequiredDescription

idstringrequiredTask ID

brevomcp_tasks_get_crm_tasktypes#Retrieve the list of all available task types for your account. The default task types are Email, Call, Todo, Meeting, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned.0 params▾

Retrieve the list of all available task types for your account. The default task types are Email, Call, Todo, Meeting, Lunch, Deadline, and LinkedIn. If no task types exist yet, the default set is automatically created and returned.

brevomcp_tasks_patch_crm_tasks_by_id#Update an existing CRM task's properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.12 params▾

Update an existing CRM task's properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities. Only the fields provided in the request body will be updated; omitted fields remain unchanged.

NameTypeRequiredDescription

idstringrequiredTask ID

assignToIdstringoptionalTo assign a task to a user you can use either the account email or ID.

companiesIdsstringoptionalCompanies ids for companies a task is linked to

contactsIdsstringoptionalContact ids for contacts linked to this task

datestringoptionalTask date/time

dealsIdsstringoptionalDeal ids for deals a task is linked to

donestringoptionalTask marked as done

durationstringoptionalDuration of task in milliseconds [1 minute = 60000 ms]

namestringoptionalName of task

notesstringoptionalNotes added to a task

reminderstringoptionalTask reminder date/time for a task

taskTypeIdstringoptionalId for type of task e.g Call / Email / Meeting etc.

brevomcp_tasks_post_crm_tasks#Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.11 params▾

Create a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals. A task requires a name, task type ID, and due date at minimum. You can also set a duration, notes, a reminder, and assign the task to a specific user.

NameTypeRequiredDescription

datestringrequiredTask due date and time

namestringrequiredName of task

taskTypeIdstringrequiredId for type of task e.g Call / Email / Meeting etc.

assignToIdstringoptionalTo assign a task to a user you can use either the account email or ID.

companiesIdsstringoptionalCompanies ids for companies a task is linked to

contactsIdsstringoptionalContact ids for contacts linked to this task

dealsIdsstringoptionalDeal ids for deals a task is linked to

donestringoptionalTask marked as done

durationstringoptionalDuration of task in milliseconds [1 minute = 60000 ms]

notesstringoptionalNotes added to a task

reminderstringoptionalTask reminder date/time for a task

brevomcp_templates_create_smtp_template#Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied.10 params▾

Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied.

NameTypeRequiredDescription

senderstringrequiredSender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}

subjectstringrequiredSubject of the template

templateNamestringrequiredName of the template

attachmentUrlstringoptionalAbsolute url of the attachment (no local file). Extension allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps'

htmlContentstringoptionalBody of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty

htmlUrlstringoptionalUrl which contents the body of the email message. REQUIRED if htmlContent is empty

isActivestringoptionalStatus of template. isActive = true means template is active and isActive = false means template is inactive

replyTostringoptionalEmail on which campaign recipients will be able to reply to

tagstringoptionalTag of the template

toFieldstringoptionalTo personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

brevomcp_templates_delete_smtp_template#Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`.1 param▾

Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`.

NameTypeRequiredDescription

templateIdintegerrequiredid of the template

brevomcp_templates_get_smtp_template#Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string.1 param▾

Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string.

NameTypeRequiredDescription

templateIdstringrequiredID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter).

brevomcp_templates_get_smtp_templates#Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden.5 params▾

Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden.

NameTypeRequiredDescription

editorTypestringoptionalFilter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value.

limitstringoptionalNumber of documents returned per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

templateStatusstringoptionalFilter on the status of the template. Active = true, inactive = false

brevomcp_templates_post_preview_smtp_email_templates#Generate a fully rendered preview of a transactional email template by resolving dynamic variables.3 params▾

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

NameTypeRequiredDescription

templateIdintegerrequiredId of the template.

emailstringoptionalEmail of the contact.(Required if params not provided)

paramsstringoptionalKey-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: {"Firstname":"John", "Lastname":"Doe"}

brevomcp_templates_send_test_template#Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your default test list.2 params▾

Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your default test list.

NameTypeRequiredDescription

templateIdintegerrequiredID of the transactional template to send as a test. Must be a valid positive integer.

emailTostringoptionalList of the email addresses of the recipients whom you wish to send the test mail. _If left empty, the test mail will be sent to your entire test list. You can not send more than 50 test emails per day_.

brevomcp_templates_update_smtp_template#Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated.11 params▾

Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated.

NameTypeRequiredDescription

templateIdstringrequiredID of the template. Can be a numeric template ID or a custom template identifier string.

attachmentUrlstringoptionalAbsolute url of the attachment (no local file). Extensions allowed: #### xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub and eps

htmlContentstringoptionalRequired if htmlUrl is empty. If the template is designed using Drag & Drop editor via HTML content, then the design page will not have Drag & Drop editor access for that template. Body of the message (HTML must have more than 10 characters)

htmlUrlstringoptionalRequired if htmlContent is empty. URL to the body of the email (HTML)

isActivestringoptionalStatus of the template. isActive = false means template is inactive, isActive = true means template is active

replyTostringoptionalEmail on which campaign recipients will be able to reply to

senderstringoptionalSender details including id or email and name (_optional_). Only one of either Sender's email or Sender's ID shall be passed in one request at a time. For example: {"name":"xyz", "email":"example@abc.com"} {"name":"xyz", "id":123}

subjectstringoptionalSubject of the email

tagstringoptionalTag of the template

templateNamestringoptionalName of the template

toFieldstringoptionalTo personalize the To Field. If you want to include the first name and last name of your recipient, add {FNAME} {LNAME}. These contact attributes must already exist in your Brevo account. If input parameter params used please use {{contact.FNAME}} {{contact.LNAME}} for personalization

brevomcp_transac_templates_block_new_domain#Block a new domain to prevent transactional emails from being sent to any recipient at that domain. The `domain` field is required and must be a valid domain name (e.g. `example.com`). Domain names starting with `www.` are not accepted.1 param▾

Block a new domain to prevent transactional emails from being sent to any recipient at that domain. The `domain` field is required and must be a valid domain name (e.g. `example.com`). Domain names starting with `www.` are not accepted.

NameTypeRequiredDescription

domainstringrequiredname of the domain to be blocked

brevomcp_transac_templates_delete_blocked_domain#Remove a domain from the blocked domains list, allowing transactional emails to be sent to recipients at that domain again. The domain name must be a valid domain format (e.g. `example.com`).1 param▾

Remove a domain from the blocked domains list, allowing transactional emails to be sent to recipients at that domain again. The domain name must be a valid domain format (e.g. `example.com`).

NameTypeRequiredDescription

domainstringrequiredThe name of the domain to be deleted

brevomcp_transac_templates_delete_hardbounces#Delete hard bounce records from the blocklist, to be used carefully (e.g. in case of temporary ISP failures). You can filter by `contactEmail` (a specific email address), by date range (`startDate` and `endDate` in YYYY-MM-DD format), or both.3 params▾

Delete hard bounce records from the blocklist, to be used carefully (e.g. in case of temporary ISP failures). You can filter by `contactEmail` (a specific email address), by date range (`startDate` and `endDate` in YYYY-MM-DD format), or both.

NameTypeRequiredDescription

contactEmailstringoptionalTarget a specific email address

endDatestringoptionalEnding date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate

startDatestringoptionalStarting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate

brevomcp_transac_templates_delete_scheduled_email_by_id#Delete scheduled transactional emails, either a batch by its UUIDv4 `batchId` or a single email by its `messageId` (enclosed in angle brackets with an @ sign). Only emails with a `queued` status can be deleted; processed or in-progress emails cannot be cancelled.1 param▾

Delete scheduled transactional emails, either a batch by its UUIDv4 `batchId` or a single email by its `messageId` (enclosed in angle brackets with an @ sign). Only emails with a `queued` status can be deleted; processed or in-progress emails cannot be cancelled.

NameTypeRequiredDescription

identifierstringrequiredThe `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`).

brevomcp_transac_templates_delete_smtp_blocked_contacts_by_email#Unblock or resubscribe a transactional contact by removing their email address from the blocklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.1 param▾

Unblock or resubscribe a transactional contact by removing their email address from the blocklist. The email address must be URL-encoded in the path parameter and must be a valid email format. If the contact is not found in the blocklist, a 404 error is returned.

NameTypeRequiredDescription

emailstringrequiredEmail address (URL-encoded) of the contact to unblock. Must be a valid email format.

brevomcp_transac_templates_delete_smtp_log_by_identifier#Delete SMTP transactional log entries by message ID or email address.3 params▾

Delete SMTP transactional log entries by message ID or email address.

NameTypeRequiredDescription

identifierstringrequiredMessage ID or email address of the transactional log(s) to delete. A message ID must be enclosed in angle brackets with an @ sign (e.g. `<abc123@domain.com>`). Alternatively, provide a valid email address to delete all logs associated with that address.

from_datestringoptionalStarting date (YYYY-MM-DD format) to narrow down logs for deletion

to_datestringoptionalEnding date (YYYY-MM-DD format) to narrow down logs for deletion

brevomcp_transac_templates_get_blocked_domains#Retrieve the complete list of domains that have been blocked for transactional email sending. Blocked domains prevent any transactional email from being sent to recipients at those domains. The response contains a flat array of domain name strings.0 params▾

Retrieve the complete list of domains that have been blocked for transactional email sending. Blocked domains prevent any transactional email from being sent to recipients at those domains. The response contains a flat array of domain name strings.

brevomcp_transac_templates_get_scheduled_email_by_id#Fetch the status of scheduled transactional emails, either a batch by its UUIDv4 `batchId` or a single email by its `messageId` (enclosed in angle brackets with an @ sign). Data is available for up to 30 days from creation.7 params▾

Fetch the status of scheduled transactional emails, either a batch by its UUIDv4 `batchId` or a single email by its `messageId` (enclosed in angle brackets with an @ sign). Data is available for up to 30 days from creation.

NameTypeRequiredDescription

identifierstringrequiredThe `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored.

endDatestringoptionalMandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

limitstringoptionalNumber of documents returned per page. Not valid when identifier is `messageId`.

offsetstringoptionalIndex of the first document on the page. Not valid when identifier is `messageId`.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed. Not valid when identifier is `messageId`.

startDatestringoptionalMandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date.

statusstringoptionalFilter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.

brevomcp_transac_templates_get_sms_events#Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden.9 params▾

Retrieve a paginated list of individual SMS event records (unaggregated), including event type, phone number, message ID, timestamp, tag, and reason or reply content where applicable. Results default to 50 per page (max 100) and are sorted in descending order unless overridden.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.

eventstringoptionalFilter the report for specific events

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document of the page

phoneNumberstringoptionalFilter the report for a specific phone number

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.

tagsstringoptionalFilter the report for specific tags, passed as a comma-separated URL-encoded string

brevomcp_transac_templates_get_sms_templates#Retrieve a paginated list of all your SMS templates with their content, compliance settings, and media attachments. Results are paginated with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by creation date.3 params▾

Retrieve a paginated list of all your SMS templates with their content, compliance settings, and media attachments. Results are paginated with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by creation date.

NameTypeRequiredDescription

limitstringoptionalNumber of documents returned per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

brevomcp_transac_templates_get_transac_aggregated_sms_report#Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages.4 params▾

Retrieve an aggregated report of your transactional SMS activity over a specified time period, including counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer). Not compatible with startDate and endDate

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.

tagstringoptionalFilter results by a specific tag

brevomcp_transac_templates_get_transac_blocked_contacts#Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation).6 params▾

Retrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g. hard bounce, admin blocked, spam complaint, or unsubscription via email/API/Marketing Automation).

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts

limitstringoptionalNumber of documents returned per page

offsetstringoptionalIndex of the first document on the page

sendersstringoptionalComma separated list of emails of the senders from which contacts are blocked or unsubscribed

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts

brevomcp_transac_templates_get_transac_email_content#Retrieve the full content and event history of a specific sent transactional email by its unique ID (uuid).1 param▾

Retrieve the full content and event history of a specific sent transactional email by its unique ID (uuid).

NameTypeRequiredDescription

uuidstringrequiredUnique id of the transactional email that has been sent to a particular contact

brevomcp_transac_templates_get_transac_emails_list#Retrieve a paginated list of sent transactional emails. At least one filter is required: `email`, `templateId`, or `messageId`. Without date filters, the API returns data from the last 30 days.8 params▾

Retrieve a paginated list of sent transactional emails. At least one filter is required: `email`, `templateId`, or `messageId`. Without date filters, the API returns data from the last 30 days.

NameTypeRequiredDescription

emailstringoptionalMandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

limitstringoptionalNumber of documents returned per page

messageIdstringoptionalMandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.

templateIdstringoptionalMandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.

brevomcp_transac_templates_get_transac_sms_report#Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages.5 params▾

Retrieve a day-by-day breakdown of your transactional SMS activity, with each entry containing the date and counts for requests, delivered, hard bounces, soft bounces, blocked, unsubscribed, replied, accepted, rejected, and skipped messages.

NameTypeRequiredDescription

daysstringoptionalNumber of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

endDatestringoptionalMandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.

tagstringoptionalFilter results by a specific tag

brevomcp_transac_templates_send_async_transactional_sms#Send a transactional SMS message asynchronously to a single mobile number. This endpoint has the same request body as `POST /transactionalSMS/sms` but returns only the `messageId` without waiting for credit and delivery details.10 params▾

Send a transactional SMS message asynchronously to a single mobile number. This endpoint has the same request body as `POST /transactionalSMS/sms` but returns only the `messageId` without waiting for credit and delivery details.

NameTypeRequiredDescription

recipientstringrequiredMobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'.

senderstringrequiredName of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits.

contentstringoptionalContent of the message. If more than 160 characters long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed.

organisationPrefixstringoptionalA recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

paramsstringoptionalPass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used.

tagstringoptionalTag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.

templateIdstringoptionalTemplate ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed.

typestringoptionalType of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.

unicodeEnabledstringoptionalFormat of the message. It indicates whether the content should be treated as unicode or not.

webUrlstringoptionalWebhook to call for each event triggered by the message (delivered etc.)

brevomcp_transac_templates_send_transac_email#Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`.16 params▾

Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`.

NameTypeRequiredDescription

attachmentstringoptionalArray of attachment objects. Each attachment must include either an absolute URL (no local file paths) or base64-encoded content, along with the attachment filename. The `name` field is required when `content` is provided. Supported file extensions: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass, xlsm. When `templateId` is specified: if the template uses the New Template Language format, both `url` and `content` attachment types are supported; if the template uses the Old Template Language format, the `attachment` parameter is ignored.

batchIdstringoptionalUUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated.

bccstringoptionalArray of BCC recipient objects. Each object contains an email address and an optional name.

ccstringoptionalArray of CC recipient objects. Each object contains an email address and an optional name.

headersstringoptionalCustom email headers (non-standard headers) to include in the email. The `sender.ip` header can be set to specify the IP address used for sending transactional emails (dedicated IP users only). Header names must use Title-Case-Format (words separated by hyphens with the first letter of each word capitalized). Headers not in this format are automatically converted. Standard email headers are not supported. Example: `{"sender.ip":"1.2.3.4", "X-Mailin-custom":"some_custom_value", "Idempotency-Key":"abc-123"}`

htmlContentstringoptionalHTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided.

messageVersionsstringoptionalArray of message version objects for sending customized email variants. The `templateId` can be customized per version only if a global `templateId` is provided. The `htmlContent` and `textContent` can be customized per version only if at least one of these is present in the global parameters. Global parameters such as `to` (required), `bcc`, `cc`, `replyTo`, and `subject` can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual `params` objects must not exceed 100 KB. Cumulative `params` across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions.

paramsstringoptionalKey-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.

replyTostringoptionalReply-to email address (required) and optional display name. Recipients will use this address when replying to the email.

scheduledAtstringoptionalUTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes.

senderstringoptionalSender information. Required when `templateId` is not provided. Specify either an email address (with optional name) or a sender ID. The `name` field is ignored when `id` is provided.

subjectstringoptionalEmail subject line. Required when `templateId` is not provided.

tagsstringoptionalArray of tags for categorizing and filtering emails

templateIdstringoptionalTemplate identifier

textContentstringoptionalPlain text body content of the email. Ignored when `templateId` is provided.

tostringoptionalArray of recipient objects. Each object contains an email address and an optional display name. Required when `messageVersions` is not provided. Ignored when `messageVersions` is provided. Example: `[{"name":"Jimmy", "email":"jimmy@example.com"}, {"name":"Joe", "email":"joe@example.com"}]`

brevomcp_transac_templates_send_transac_sms#Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required.10 params▾

Send a transactional SMS message to a single mobile number. The `sender`, `recipient`, and either `content` or `templateId` fields are required.

NameTypeRequiredDescription

recipientstringrequiredMobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'.

senderstringrequiredName of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters. Alphanumeric sender names (up to 11 characters) must contain only letters and digits. Numeric sender names (12-15 characters) must contain only digits.

contentstringoptionalContent of the message. If more than 160 characters long, will be sent as multiple text messages. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed.

organisationPrefixstringoptionalA recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

paramsstringoptionalPass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used.

tagstringoptionalTag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.

templateIdstringoptionalTemplate ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed.

typestringoptionalType of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.

unicodeEnabledstringoptionalFormat of the message. It indicates whether the content should be treated as unicode or not.

webUrlstringoptionalWebhook to call for each event triggered by the message (delivered etc.)

brevomcp_users_edit_user_permission#Updates the feature-level permissions for an existing user in the organization.3 params▾

Updates the feature-level permissions for an existing user in the organization.

NameTypeRequiredDescription

all_features_accessstringrequiredAll access to the features

emailstringrequiredEmail address for the organization

privilegesstringrequiredNo description.

brevomcp_users_get_invited_users_list#Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.0 params▾

Retrieves the list of all users associated with your organization, including both active and pending invited users. Each user entry includes their email address, owner status, current invitation status, and feature access levels for marketing, CRM, and conversations.

brevomcp_users_get_user_permission#Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user's current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.1 param▾

Retrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address. The response includes the user's current status (active or pending) and a detailed list of privileges specifying which features and permission levels are granted.

NameTypeRequiredDescription

emailstringrequiredEmail of the invited user.

brevomcp_users_inviteuser#Invite a new user to the organization with specified feature permissions.3 params▾

Invite a new user to the organization with specified feature permissions.

NameTypeRequiredDescription

all_features_accessstringrequiredAll access to the features

emailstringrequiredEmail address for the organization

privilegesstringrequiredNo description.

brevomcp_users_put_revoke_user_permission#Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user's plan change generated credit notes, they are returned in the response for billing reconciliation.1 param▾

Revokes all permissions for an invited user in the organization, effectively removing their access to the platform. If the user's plan change generated credit notes, they are returned in the response for billing reconciliation.

NameTypeRequiredDescription

emailstringrequiredEmail of the invited user.

brevomcp_users_putresendcancelinvitation#Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user's pending access.2 params▾

Resends or cancels a pending invitation for a user in the organization, depending on the action path parameter. Use `resend` to send a new invitation email to the user, or `cancel` to revoke the pending invitation entirely and remove the user's pending access.

NameTypeRequiredDescription

actionstringrequiredaction

emailstringrequiredEmail of the invited user.

brevomcp_webhooks_management_create_webhook#Creates a new webhook to receive real-time notifications for specified events. You can create up to 40 active webhooks per account (excluding inbound type webhooks).9 params▾

Creates a new webhook to receive real-time notifications for specified events. You can create up to 40 active webhooks per account (excluding inbound type webhooks).

NameTypeRequiredDescription

urlstringrequiredURL of the webhook

authstringoptionalAdd authentication on webhook url

batchedstringoptionalTo send batched webhooks

channelstringoptionalChannel of the webhook

descriptionstringoptionalDescription of the webhook

domainstringoptionalInbound domain of webhook, required in case of event type `inbound`

eventsstringoptionalEvents triggering the webhook. Required for transactional and marketing types, optional for inbound type (defaults to `inboundEmailProcessed`). Possible values for Transactional type webhook: `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed`. Possible values for Marketing type webhook: `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition`, `delivered`, `contactUpdated` & `contactDeleted`. Possible values for Inbound type webhook: `inboundEmailProcessed`.

headersstringoptionalCustom headers to be send with webhooks

typestringoptionalType of the webhook

brevomcp_webhooks_management_delete_webhook#Permanently deletes a webhook and stops all event notifications.1 param▾

Permanently deletes a webhook and stops all event notifications.

NameTypeRequiredDescription

webhookIdintegerrequiredId of the webhook

brevomcp_webhooks_management_export_webhooks_history#Exports webhook event history to CSV format for analysis and reporting.10 params▾

Exports webhook event history to CSV format for analysis and reporting.

NameTypeRequiredDescription

eventstringrequiredFilter the history for a specific event type

notifyURLstringrequiredWebhook URL to receive CSV file link

typestringrequiredFilter the history based on webhook type

daysstringoptionalNumber of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'.

emailstringoptionalFilter the history for a specific email

endDatestringoptionalMandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than or equal to startDate.

messageIdstringoptionalFilter the history for a specific message id. Applicable only for transactional webhooks.

sortstringoptionalSorting order of records (asc or desc)

startDatestringoptionalMandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than or equal to endDate.

webhookIdstringoptionalFilter the history for a specific webhook id

brevomcp_webhooks_management_get_webhook#Retrieves detailed information about a specific webhook configuration.1 param▾

Retrieves detailed information about a specific webhook configuration.

NameTypeRequiredDescription

webhookIdintegerrequiredId of the webhook

brevomcp_webhooks_management_get_webhooks#Retrieves all webhooks from your Brevo account with filtering and sorting options. If no `type` filter is specified, transactional webhooks are returned by default.2 params▾

Retrieves all webhooks from your Brevo account with filtering and sorting options. If no `type` filter is specified, transactional webhooks are returned by default.

NameTypeRequiredDescription

sortstringoptionalSort the results in the ascending/descending order of webhook creation

typestringoptionalFilter on webhook type

brevomcp_webhooks_management_update_webhook#Updates an existing webhook configuration and event subscriptions. The webhook type (marketing, transactional, or inbound) cannot be changed after creation -- only the URL, events, description, authentication, headers, batching, and domain (for inbound) can be updated.8 params▾

Updates an existing webhook configuration and event subscriptions. The webhook type (marketing, transactional, or inbound) cannot be changed after creation -- only the URL, events, description, authentication, headers, batching, and domain (for inbound) can be updated.

NameTypeRequiredDescription

webhookIdintegerrequiredId of the webhook

authstringoptionalAdd authentication on webhook url

batchedstringoptionalTo send batched webhooks

descriptionstringoptionalDescription of the webhook

domainstringoptionalInbound domain of webhook, used in case of event type `inbound`

eventsstringoptional- Events triggering the webhook. Possible values for Transactional type webhook: `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed`. Possible values for Marketing type webhook: `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition`, `delivered`, `contactUpdated` and `contactDeleted`. Possible values for Inbound type webhook: `inboundEmailProcessed`.

headersstringoptionalCustom headers to be send with webhooks

urlstringoptionalURL of the webhook

brevomcp_whatsapp_campaigns_create_whats_app_campaign#Create a new WhatsApp campaign and schedule it for sending. The campaign requires a name, an approved WhatsApp template ID, a scheduled sending time, and recipients (either list IDs or segment IDs). The template must be in an approved state before it can be used.4 params▾

Create a new WhatsApp campaign and schedule it for sending. The campaign requires a name, an approved WhatsApp template ID, a scheduled sending time, and recipients (either list IDs or segment IDs). The template must be in an approved state before it can be used.

NameTypeRequiredDescription

namestringrequiredName of the WhatsApp campaign creation

recipientsstringrequiredSegment ids and List ids to include/exclude from campaign

scheduledAtstringrequiredSending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00

templateIdintegerrequiredId of the WhatsApp template in approved state

brevomcp_whatsapp_campaigns_delete_whats_app_campaign#Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.1 param▾

Delete a WhatsApp campaign by its campaign ID. The campaign must exist; if the campaign ID is not found, a 404 error is returned. This action is permanent and cannot be undone.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

brevomcp_whatsapp_campaigns_get_whats_app_campaign#Retrieve detailed information about a specific WhatsApp campaign by its ID, including campaign status, recipients, sender number, template details, and delivery statistics. The response includes the full template structure with body variables, header variables, and button configuration.1 param▾

Retrieve detailed information about a specific WhatsApp campaign by its ID, including campaign status, recipients, sender number, template details, and delivery statistics. The response includes the full template structure with body variables, header variables, and button configuration.

NameTypeRequiredDescription

campaignIdintegerrequiredId of the campaign

brevomcp_whatsapp_campaigns_get_whats_app_campaigns#Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.5 params▾

Retrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata. Results can be filtered by creation date range using startDate and endDate, with a default limit of 50 and maximum of 100 per page. The sort order defaults to descending by modification date.

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. Prefer to pass your timezone in date-time format for accurate result

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created. Prefer to pass your timezone in date-time format for accurate result

brevomcp_whatsapp_campaigns_get_whats_app_config#Retrieve the configuration and status of your WhatsApp Business API account, including verification status, phone number name status, phone number quality rating, sending limit tier, and overall account approval status.0 params▾

Retrieve the configuration and status of your WhatsApp Business API account, including verification status, phone number name status, phone number quality rating, sending limit tier, and overall account approval status.

brevomcp_whatsapp_campaigns_get_whats_app_templates#Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page.6 params▾

Retrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata. Results can be filtered by creation date range and optionally by source (Automation or Conversations), with a default limit of 50 and maximum of 100 per page.

NameTypeRequiredDescription

endDatestringoptionalMandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result

limitstringoptionalNumber of documents per page

offsetstringoptionalIndex of the first document in the page

sortstringoptionalSort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed

sourcestringoptionalsource of the template

startDatestringoptionalMandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. Prefer to pass your timezone in date-time format for accurate result

brevomcp_whatsapp_campaigns_send_whats_app_template_approval#Submit a WhatsApp template for approval by Meta. The template must exist and be in a state that allows submission (e.g. draft or rejected). Once approved, the template can be used in WhatsApp campaigns. You must have a configured WhatsApp account on the Brevo platform to use this endpoint.1 param▾

Submit a WhatsApp template for approval by Meta. The template must exist and be in a state that allows submission (e.g. draft or rejected). Once approved, the template can be used in WhatsApp campaigns. You must have a configured WhatsApp account on the Brevo platform to use this endpoint.

NameTypeRequiredDescription

templateIdintegerrequiredid of the template

brevomcp_whatsapp_campaigns_update_whats_app_campaign#Update an existing WhatsApp campaign's name, status, recipients, or scheduled sending time. The campaign must exist and be in a modifiable state (draft or scheduled). Use the rescheduleFor field to change the sending time.5 params▾

Update an existing WhatsApp campaign's name, status, recipients, or scheduled sending time. The campaign must exist and be in a modifiable state (draft or scheduled). Use the rescheduleFor field to change the sending time.

NameTypeRequiredDescription

campaignIdintegerrequiredid of the campaign

campaignNamestringoptionalName of the campaign

campaignStatusstringoptionalStatus of the campaign

recipientsstringoptionalSegment ids and List ids to include/exclude from campaign

rescheduleForstringoptionalReschedule the sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of campaign. Prefer to pass your timezone in date-time format for accurate result.For example: 2017-06-01T12:30:00+02:00 Use this field to update the scheduledAt of any existing draft or scheduled WhatsApp campaign.

brevomcp_whatsapp_management_create_whats_app_template#Create a new WhatsApp message template with the specified name, language, category, and body text. Templates can optionally include a text header (max 45 characters) or a media header (image, video, or PDF via URL). The body text supports a maximum of 1024 characters.7 params▾

Create a new WhatsApp message template with the specified name, language, category, and body text. Templates can optionally include a text header (max 45 characters) or a media header (image, video, or PDF via URL). The body text supports a maximum of 1024 characters.

NameTypeRequiredDescription

bodyTextstringrequiredBody of the template. Maximum allowed characters are 1024

categorystringrequiredCategory of the template

languagestringrequiredLanguage of the template. For Example : en for English

namestringrequiredName of the template

headerTextstringoptionalText content of the header in the template. Maximum allowed characters are 45 Use this field to add text content in template header and if mediaUrl is empty

mediaUrlstringoptionalAbsolute url of the media file (no local file) for the header. Use this field in you want to add media in Template header and headerText is empty Allowed extensions for media files are: #### jpeg | png | mp4 | pdf

sourcestringoptionalsource of the template

brevomcp_whatsapp_management_get_whatsapp_event_report#Retrieve a paginated list of individual WhatsApp event records (unaggregated), including event type, contact number, sender number, message ID, timestamp, and contextual fields like body text, media URL, and error reason where applicable.8 params▾

Retrieve a paginated list of individual WhatsApp event records (unaggregated), including event type, contact number, sender number, message ID, timestamp, and contextual fields like body text, media URL, and error reason where applicable.

NameTypeRequiredDescription

contactNumberstringoptionalFilter results for specific contact (WhatsApp Number with country code. Example, 85264318721)

daysstringoptionalNumber of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_

endDatestringoptionalMandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

eventstringoptionalFilter the report for a specific event type

limitstringoptionalNumber limitation for the result returned

offsetstringoptionalBeginning point in the list to retrieve from

sortstringoptionalSort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed

startDatestringoptionalMandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

brevomcp_whatsapp_management_send_whatsapp_message#Send a WhatsApp message to one or more contacts. You must have your WhatsApp account set up on the Brevo platform before using this endpoint. The first message sent via the API must use a `templateId` (created on the Brevo WhatsApp interface); subsequent messages can use free-form `text` instead.5 params▾

Send a WhatsApp message to one or more contacts. You must have your WhatsApp account set up on the Brevo platform before using this endpoint. The first message sent via the API must use a `templateId` (created on the Brevo WhatsApp interface); subsequent messages can use free-form `text` instead.

NameTypeRequiredDescription

contactNumbersstringrequiredList of phone numbers of the contacts

senderNumberstringrequiredWhatsApp Number with country code. Example, 85264318721

paramsstringoptionalPass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}.

templateIdstringoptionalID of the template to send

textstringoptionalText to be sent as message body (will be overridden if templateId is passed in the same request)