The Brevo MCP connector routes your AI agent's tool calls to Brevo's own MCP server through Scalekit. Each user signs in to Brevo once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 282 tools.
- Tools
- 282
- What they doRead · write · destructive
- 112 · 133 · 37112 read133 write37 destructive
- Users sign in with
- OAuth
- OAuth app
- Scalekit's or your own
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Brevo MCP connection
In AgentKit > Connections, create a Brevo MCP connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Scalekit credentials are available for Brevo MCP server, so you don't need to register an OAuth app.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'brevomcp'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Brevo MCP:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'brevomcp_accounts_get_account',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "brevomcp"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="brevomcp_accounts_get_account",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbrevomcp_accounts_get_accountRetrieves details of your Brevo account.Read-onlyAccounts Get Account
Retrieves details of your Brevo account.
Inputs
This tool takes no inputs.
brevomcp_accounts_get_account_activityRetrieves user activity logs from your organization for security monitoring and audit compliance.Read-onlyAccounts Get Account Activity
Retrieves user activity logs from your organization for security monitoring and audit compliance.
Inputs
emailstring- Enter the user's email address to filter their activity in the account.
endDatestring- Mandatory 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.
limitstring- Number of documents per page
offsetstring- Index of the first document in the page.
startDatestring- Mandatory 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_listThis endpoint allows you to list all Admin users of your Admin account.Read-onlyAccounts 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.
Inputs
limitstring- Number of users to be displayed on each page. This is optional, the default limit is 20, but max allowed limit is 100.
offsetstring- Page number for the result set. This is optional, default value will be the 1st page.
typestring- User type (active | pending). This is required if offset is provided for limited result.
brevomcp_accounts_get_corporate_ipRetrieves the list of all active dedicated IPs available on the corporate admin account.Read-onlyAccounts 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.
Inputs
This tool takes no inputs.
brevomcp_accounts_get_corporate_master_accountRetrieves comprehensive details of the corporate master account, including company information, billing details, current plan configuration with feature quotas, and timezone settings.Read-onlyAccounts 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.
Inputs
This tool takes no inputs.
brevomcp_accounts_get_corporate_sub_accountRetrieves a paginated list of all sub-accounts under the corporate master account.Read-onlyAccounts 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.
Inputs
limitintegerrequired- Number of sub-accounts to be displayed on each page
offsetintegerrequired- Index of the first sub-account in the page
brevomcp_accounts_get_corporate_sub_account_by_idRetrieves detailed information about a specific sub-account including company name, contact email, group memberships, and comprehensive plan details with credit quotas and feature allocations.Read-onlyAccounts 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.
Inputs
idintegerrequired- Id of the sub-account organization
brevomcp_accounts_get_corporate_user_permissionRetrieves the granular feature-level permissions assigned to a specific admin user, identified by their email address.Read-onlyAccounts 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.
Inputs
emailstringrequired- Email of the invited user.
brevomcp_attributes_get_attributesRetrieve all contact attributes defined in your Brevo account, grouped by category (normal, transactional, category, calculated, global).Read-onlyAttributes 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.
Inputs
This tool takes no inputs.
brevomcp_attributes_get_crm_attributes_companiesRetrieve the list of all attributes defined for companies, including both system-default and custom attributes.Read-onlyAttributes 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.
Inputs
This tool takes no inputs.
brevomcp_attributes_get_crm_attributes_dealsRetrieve the list of all attributes defined for deals, including both system-default and custom attributes.Read-onlyAttributes 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.
Inputs
This tool takes no inputs.
brevomcp_campaign_analytics_get_ab_test_campaign_resultRetrieve the results of an A/B test email campaign, including the winning version, open and click rates, and per-version statistics.Read-onlyCampaign 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.
Inputs
campaignIdintegerrequired- Id of the A/B test campaign
brevomcp_campaign_analytics_get_aggregated_smtp_reportRetrieve aggregated transactional email statistics (requests, delivered, opens, clicks, bounces, spam reports, blocked, invalid, unsubscribed) for a specified time period.Read-onlyCampaign 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.
Inputs
daysstring- Number 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.
endDatestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
startDatestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
tagstring- Tag of the emails
brevomcp_campaign_analytics_get_email_event_reportRetrieve 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.Read-onlyCampaign 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.
Inputs
daysstring- Number 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.
emailstring- Filter the report for a specific email addresses
endDatestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
eventstring- Filter the report for a specific event type
limitstring- Number limitation for the result returned
messageIdstring- Filter on a specific message id
offsetstring- Beginning point in the list to retrieve from.
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
tagsstring- Filter the report for tags (serialized and urlencoded array)
templateIdstring- Filter on a specific template id
brevomcp_campaign_analytics_get_smtp_reportRetrieve 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.Read-onlyCampaign 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.
Inputs
daysstring- Number of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_
endDatestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
limitstring- Number of documents returned per page
offsetstring- Index of the first document on the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
tagstring- Tag of the emails
brevomcp_categories_get_categoriesRetrieve a paginated list of all ecommerce categories stored in your Brevo account.Read-onlyCategories 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.
Inputs
createdSincestring- Filter (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.
idsstring- Filter by category ids
isDeletedstring- Filter categories by their deletion status. If `false` is passed, only categories that are not deleted will be returned.
limitstring- Number of documents per page
modifiedSincestring- Filter (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.
namestring- Filter by category name
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_categories_get_category_infoRetrieve the full details of a single ecommerce category by its unique ID.Read-onlyCategories 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.
Inputs
idstringrequired- Category ID
brevomcp_companies_get_by_idRetrieve the full details of a single company by its identifier, including its attributes, linked contacts, and linked deals.Read-onlyCompanies 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.
Inputs
idstringrequired- Get Company Details
brevomcp_companies_get_companiesRetrieve a paginated list of companies with optional filtering, sorting, and search capabilities.Read-onlyCompanies 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.
Inputs
createdSincestring- Filter (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_namestring- Filter 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.
limitstring- Number of documents per page
linkedContactsIdsstring- Filter by linked contacts ids
linkedDealsIdsstring- Filter by linked Deals ids
modifiedSincestring- Filter (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.
pagestring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed
sortBystring- The field used to sort field names.
brevomcp_contact_import_export_get_contacts_from_listRetrieve all contacts belonging to a specific list, identified by its list ID.Read-onlyContact 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.
Inputs
listIdintegerrequired- Id of the list
limitstring- Number of documents per page
modifiedSincestring- Filter (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.
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_contacts_get_contact_infoRetrieve contact details by email, phone, or Brevo contact ID.Read-onlyContacts Get Contact Info
Retrieve contact details by email, phone, or Brevo contact ID.
Inputs
identifierstringrequired- Email (urlencoded) OR ID of the contact OR its SMS attribute value OR EXT_ID attribute (urlencoded)
endDatestring- Mandatory 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.
identifierTypestring- email_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
startDatestring- Mandatory 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_statsRetrieve email campaign statistics for a specific contact identified by email address or numeric ID.Read-onlyContacts 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.
Inputs
identifierstringrequired- Email 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.
endDatestring- Mandatory 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.
startDatestring- Mandatory 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_contactsRetrieve all contacts from your Brevo account with support for pagination, filtering, and sorting.Read-onlyContacts Get Contacts
Retrieve all contacts from your Brevo account with support for pagination, filtering, and sorting.
Inputs
createdSincestring- Filter (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.
filterstring- Filter 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")
idsstring- Filter by a list of contact IDs. You can pass a maximum of 20 IDs. All elements must be integers.
limitstring- Number of documents per page
listIdsstring- Ids of the list. Either listIds or segmentId can be passed.
modifiedSincestring- Filter (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.
offsetstring- Index of the first document of the page
segmentIdstring- Id of the segment. Either listIds or segmentId can be passed. Must be a positive integer (minimum value of 1).
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_conversations_get_messages_by_idRetrieve a single message by its ID.Read-onlyConversations 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.
Inputs
idstringrequired- ID of the message
brevomcp_conversations_get_pushed_messages_by_idRetrieve a single automated (pushed) message by its ID.Read-onlyConversations 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.
Inputs
idstringrequired- ID of the message sent previously
brevomcp_coupons_get_coupon_collectionRetrieve the details of a single coupon collection by its UUID.Read-onlyCoupons 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.
Inputs
idstringrequired- Id of the collection to return
brevomcp_coupons_get_coupon_collectionsRetrieve a paginated list of all coupon collections in your Brevo account.Read-onlyCoupons 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).
Inputs
limitstring- Number of documents returned per page
offsetstring- Index of the first document on the page
sortstring- Sort the results by creation time in ascending/descending order
sortBystring- The field used to sort coupon collections
brevomcp_deals_get_crm_dealsRetrieve a paginated list of deals with optional filtering, sorting, and search capabilities.Read-onlyDeals 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.
Inputs
createdSincestring- Filter (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_namestring- Filter by the deal name attribute.
filters_attributes_deal_ownerstring- Filter deals by owner. Pass the account email of the deal owner.
filters_attributes_deal_stagestring- Filter by the deal stage. Pass the stage id, retrievable from GET /crm/pipeline/details/{pipelineID}.
filters_attributes_pipelinestring- Filter by the pipeline. Pass the pipeline id, retrievable from GET /crm/pipeline/details/{pipelineID}.
filters_linkedCompaniesIdsstring- Filter by linked companies ids
filters_linkedContactsIdsstring- Filter by linked contacts ids
limitstring- Number of documents per page. Default is 50 if not specified.
modifiedSincestring- Filter (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.
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed
sortBystring- The field used to sort field names.
brevomcp_deals_get_crm_deals_by_idRetrieve the full details of a single deal by its identifier, including its attributes, pipeline stage, linked contacts, and linked companies.Read-onlyDeals 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.
Inputs
idstringrequired- No description.
brevomcp_domains_get_domain_configurationRetrieves configuration of a specific domain, to know if the domain is valid or not.Read-onlyDomains Get Domain Configuration
Retrieves configuration of a specific domain, to know if the domain is valid or not.
Inputs
domainNamestringrequired- Domain name
brevomcp_domains_get_domainsRetrieves all domains associated with the account.Read-onlyDomains Get Domains
Retrieves all domains associated with the account.
Inputs
This tool takes no inputs.
brevomcp_ecommerce_get_attribution_metricsRetrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows.Read-onlyEcommerce 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.
Inputs
automationWorkflowEmailId_string- The automation workflow ID(s) to get email attribution metrics for
automationWorkflowSmsId_string- The automation workflow ID(s) to get SMS attribution metrics for
emailCampaignId_string- The email campaign ID(s) to get metrics for
periodFromstring- When getting metrics for a specific period, define the starting datetime in RFC3339 format
periodTostring- When getting metrics for a specific period, define the end datetime in RFC3339 format
smsCampaignId_string- The SMS campaign ID(s) to get metrics for
brevomcp_ecommerce_get_attribution_metrics_by_conversion_source_idRetrieve detailed attribution metrics for a single Brevo campaign or automation workflow, identified by its conversion source type and ID.Read-onlyEcommerce 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.
Inputs
conversionSourcestringrequired- The Brevo campaign type or workflow type for which data will be retrievedone of
email_campaignsms_campaignautomation_workflow_emailautomation_workflow_sms conversionSourceIdstringrequired- The Brevo campaign or automation workflow id for which data will be retrieved
brevomcp_ecommerce_get_attribution_products_by_conversion_source_idRetrieve the list of products whose sales have been attributed to a specific Brevo campaign or automation workflow.Read-onlyEcommerce 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.
Inputs
conversionSourcestringrequired- The Brevo campaign or automation workflow type for which data will be retrievedone of
email_campaignsms_campaignautomation_workflow_emailautomation_workflow_sms conversionSourceIdstringrequired- The Brevo campaign or automation workflow id for which data will be retrieved
brevomcp_ecommerce_get_config_display_currencyRetrieve the ISO 4217 display currency code currently configured for your Brevo ecommerce account.Read-onlyEcommerce 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.
Inputs
This tool takes no inputs.
brevomcp_ecommerce_get_ordersRetrieve a paginated list of all ecommerce orders stored in your Brevo account.Read-onlyEcommerce 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).
Inputs
createdSincestring- Filter (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.
limitstring- Number of documents per page
modifiedSincestring- Filter (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.
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_email_campaign_management_get_email_campaignRetrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content.Read-onlyEmail Campaign Management Get Email Campaign
Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content.
Inputs
campaignIdintegerrequired- Id of the campaign
excludeHtmlContentstring- Use 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
statisticsstring- Filter 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_campaignsNo description available.Read-onlyEmail Campaign Management Get Email Campaigns
No description available.
Inputs
endDatestring- Mandatory 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.
excludeHtmlContentstring- Use 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.
excludePdfAttachmentstring- Use 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.
limitstring- Number of documents per page
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory 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.
statisticsstring- Filter 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.
statusstring- Filter on the status of the campaign
typestring- Filter on the type of the campaigns
brevomcp_events_get_eventsRetrieve a paginated list of events filtered by contact ID, event name, object type, and/or date range.Read-onlyEvents 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.
Inputs
contact_idstring- Filter by contact ID (repeatable).
endDatestring- Mandatory 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_namestring- Filter by event name (repeatable).
limitstring- Maximum number of events to return. Default 100, minimum 1, maximum 10000.
object_typestring- Filter by object type (repeatable).
offsetstring- Number of events to skip for pagination. Default 0, minimum 0.
startDatestring- Mandatory 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_get_all_external_feedsRetrieves all external feeds from your Brevo account with filtering and pagination.Read-onlyExternal Feeds Get All External Feeds
Retrieves all external feeds from your Brevo account with filtering and pagination.
Inputs
authTypestring- Filter the records by `authType` of the feed.
endDatestring- Mandatory 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.
limitstring- Number of documents returned per page.
offsetstring- Index of the first document on the page.
searchstring- Can be used to filter records by search keyword on feed name
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed.
startDatestring- Mandatory 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_uuidRetrieves details of a specific external feed by its UUID.Read-onlyExternal Feeds Get External Feed By Uuid
Retrieves details of a specific external feed by its UUID.
Inputs
uuidstringrequired- UUID of the feed to fetch
brevomcp_files_get_crm_filesRetrieve a paginated list of CRM files with optional filtering by entity type, entity IDs, and date range.Read-onlyFiles 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.
Inputs
dateFromstring- dateFrom to date range filter type (timestamp in milliseconds)
dateTostring- dateTo to date range filter type (timestamp in milliseconds)
entitystring- Filter by file entity type
entityIdsstring- Filter by file entity IDs
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed
brevomcp_files_get_crm_files_by_idGet a temporary download URL for a CRM file by its identifier.Read-onlyFiles 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.
Inputs
idstringrequired- File id to download.
brevomcp_files_get_crm_files_dataRetrieve the metadata and details of a specific CRM file by its identifier.Read-onlyFiles 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.
Inputs
idstringrequired- File ID to retrieve file data for
brevomcp_folders_get_folderRetrieve the details of a specific folder by its ID, including its name, subscriber counts, and blacklisted contacts count.Read-onlyFolders 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.
Inputs
folderIdintegerrequired- id of the folder
brevomcp_folders_get_folder_listsRetrieve all contact lists contained in a specific folder, identified by its folder ID.Read-onlyFolders 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.
Inputs
folderIdintegerrequired- Id of the folder
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_folders_get_foldersRetrieve all contact folders from your Brevo account with support for pagination and sorting.Read-onlyFolders 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.
Inputs
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_groups_get_corporate_group_by_idRetrieves 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.Read-onlyGroups 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.
Inputs
idstringrequired- Id of the group of sub-organization
brevomcp_groups_get_sub_account_groupsRetrieves all groups created on the corporate admin account.Read-onlyGroups 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.
Inputs
This tool takes no inputs.
brevomcp_inbound_get_email_attachmentDownload an inbound email attachment using its download token.Read-onlyInbound 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.
Inputs
downloadTokenstringrequired- Token to fetch a particular attachment.
brevomcp_inbound_get_email_eventsRetrieve a paginated list of inbound email events.Read-onlyInbound 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.
Inputs
endDatestring- Mandatory 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.
limitstring- Number of documents returned per page. Default 100, minimum 1, maximum 500.
offsetstring- Index of the first document on the page. Default 0, minimum 0.
senderstring- Email address of the sender. Must be a valid email address when provided.
sortstring- Sort the results in the ascending/descending order of record creation. Default is descending.
startDatestring- Mandatory 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_uuidRetrieve the detailed event history for a specific received email identified by its UUID.Read-onlyInbound 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).
Inputs
uuidstringrequired- UUID to fetch events specific to a received email. Must be a valid UUID format.
brevomcp_ips_get_from_senderRetrieves the dedicated IPs associated with a specific sender.Read-onlyIps Get From Sender
Retrieves the dedicated IPs associated with a specific sender.
Inputs
senderIdintegerrequired- Id of the sender
brevomcp_ips_get_ipsRetrieves all dedicated IPs associated with your Brevo account.Read-onlyIps Get Ips
Retrieves all dedicated IPs associated with your Brevo account.
Inputs
This tool takes no inputs.
brevomcp_lists_get_listRetrieve the details of a specific contact list by its ID, including its name, folder ID, creation date, subscriber counts, and campaign statistics.Read-onlyLists 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.
Inputs
listIdintegerrequired- Id of the list
endDatestring- Mandatory 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.
startDatestring- Mandatory 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_listsRetrieve all contact lists from your Brevo account with support for pagination and sorting.Read-onlyLists 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.
Inputs
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_loyalty_get_balance_definitionRetrieves a single balance definition by its ID within a loyalty program.Read-onlyLoyalty 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.
Inputs
bdidstringrequired- Balance Definition Id
pidstringrequired- Loyalty Program Id
versionstring- Version
brevomcp_loyalty_get_balance_definition_listRetrieves a paginated list of balance definitions configured for a loyalty program.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program Id
limitstring- Limit the number of records returned
offsetstring- Offset to paginate records
sortstring- Sort direction
sortFieldstring- Field to sort by
versionstring- Version
brevomcp_loyalty_get_balance_limitRetrieves a single balance limit by its ID for a given balance definition.Read-onlyLoyalty 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.
Inputs
bdidstringrequired- Balance Definition Id
blidstringrequired- Balance Limit Id
pidstringrequired- Loyalty Program Id
versionstring- Version
brevomcp_loyalty_get_balance_programs_active_balanceRetrieves a paginated list of active (non-expired, non-consumed) balance entries for a specific contact and balance definition within a loyalty program.Read-onlyLoyalty 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.
Inputs
balanceDefinitionIdstringrequired- Balance Definition ID
contactIdintegerrequired- Contact ID
pidstringrequired- Loyalty Program Id
includeInternalstring- Include balances tied to internal definitions.
limitstring- Limit
offsetstring- Offset
sortstring- Sort Order
sortFieldstring- Sort Field
brevomcp_loyalty_get_balance_programs_transaction_historyRetrieves a paginated transaction history for a specific contact and balance definition within a loyalty program.Read-onlyLoyalty 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.
Inputs
balanceDefinitionIdstringrequired- Balance Definition ID
contactIdintegerrequired- Contact ID
pidstringrequired- Loyalty Program Id
limitstring- Limit the number of records returned
offsetstring- Page number to retrieve
sortstring- Sort order
sortFieldstring- Field to sort by
statusstring- Transaction status filter
transactionTypestring- Transaction type filter
brevomcp_loyalty_get_code_countRetrieves the number of available codes in a specific code pool.Read-onlyLoyalty 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.
Inputs
cpidstringrequired- Code Pool ID
pidstringrequired- Loyalty Program ID
brevomcp_loyalty_get_contact_balancesRetrieves a paginated list of contact balances for a specific balance definition across all subscriptions in a loyalty program.Read-onlyLoyalty 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`.
Inputs
balanceDefinitionIdstringrequired- Balance Definition ID (required)
pidstringrequired- Loyalty Program Id
includeInternalstring- Include balances tied to internal definitions.
limitstring- Limit the number of records returned
offsetstring- Skip a number of records
sortstring- Sort order
sortFieldstring- Field to sort by
brevomcp_loyalty_get_list_of_tier_groupsRetrieves all tier groups configured for a loyalty program.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
versionstring- Select '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_listRetrieves a paginated list of loyalty programs for the organization.Read-onlyLoyalty 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.
Inputs
limitstring- Number of documents per page
offsetstring- Index of the first document in the page
sortstring- Sort order
sort_fieldstring- Sort documents by field
brevomcp_loyalty_get_offer_programs_offersRetrieves a paginated list of rewards (offers) configured for a loyalty program.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
limitstring- Page size
offsetstring- Pagination offset
statestring- State of the reward
versionstring- Version
brevomcp_loyalty_get_offer_programs_rewards_by_ridRetrieves the full details of a reward by its ID, including configuration, rules, code generation settings, limits, products, and attribution/redemption counters.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
ridstringrequired- Reward ID
versionstring- Version
brevomcp_loyalty_get_offer_programs_vouchersRetrieves a paginated list of vouchers attributed to a specific contact within a loyalty program.Read-onlyLoyalty 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.
Inputs
contactIdintegerrequired- Contact ID
pidstringrequired- Loyalty Program ID
limitstring- Page size
metadata_key_valuestring- Metadata value for a Key filter
offsetstring- Pagination offset
rewardIdstring- Reward ID
sortstring- Sort order
sortFieldstring- Sort field
brevomcp_loyalty_get_parameter_subscription_infoRetrieves comprehensive subscription data for a contact, including balances, tier assignments, attributed rewards, and subscription members.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
contactIdstring- The contact ID to filter by.
includeInternalstring- Include balances tied to internal definitions.
loyaltySubscriptionIdstring- The loyalty subscription ID to filter by.
paramsstring- A list of filter parameters for querying the subscription info.
brevomcp_loyalty_get_program_infoRetrieves the full details of a single loyalty program by its ID, including its current state, metadata, subscription pool configuration, and timestamps.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
brevomcp_loyalty_get_program_tierRetrieves all tiers configured for a loyalty program across all tier groups.Read-onlyLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
versionstring- Select '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_balancesRetrieves the aggregate balances for a contact's subscription within a loyalty program.Read-onlyLoyalty 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.
Inputs
cidstringrequired- Contact ID
pidstringrequired- Loyalty Program Id
includeInternalstring- Include balances tied to internal definitions.
brevomcp_loyalty_get_tier_groupRetrieves the full details of a tier group by its ID, including name, upgrade and downgrade strategies, tier ordering, and schedule configurations.Read-onlyLoyalty 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.
Inputs
gidstringrequired- Tier group ID
pidstringrequired- Loyalty Program ID
versionstring- Select active to retrieve active version of tier group. Select draft to retrieve latest changes in tier group.
brevomcp_notes_get_crm_notesRetrieve a paginated list of CRM notes with optional filtering by entity type, entity IDs, and date range.Read-onlyNotes 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.
Inputs
dateFromstring- Start of date range filter (timestamp in milliseconds)
dateTostring- End of date range filter (timestamp in milliseconds)
entitystring- Filter by note entity type. Required when `entityIds` is provided.
entityIdsstring- Filter 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.
limitstring- Number of documents per page. Must be greater than 0.
offsetstring- Index of the first document of the page
sortstring- Sort 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_idRetrieve the full details of a single CRM note by its identifier.Read-onlyNotes 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.
Inputs
idstringrequired- Note ID to retrieve
brevomcp_objects_getrecordsThis API retrieves a list of object records along with their associated records and provides the total count of records for the specified object.Read-onlyObjects 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.
Inputs
limitintegerrequired- Number of records returned per page
object_typestringrequired- Object 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_numintegerrequired- Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer.
associationstring- Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided.
sortstring- Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided.
brevomcp_payments_get_payment_requestRetrieve the details of a specific payment request by its ID.Read-onlyPayments 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.
Inputs
idstringrequired- Id of the payment Request
brevomcp_pipelines_get_crm_pipeline_detailsThis endpoint is deprecated.Read-onlyPipelines 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.
Inputs
This tool takes no inputs.
brevomcp_pipelines_get_crm_pipeline_details_allRetrieve the list of all deal pipelines configured for your account, including each pipeline's stages.Read-onlyPipelines 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.
Inputs
This tool takes no inputs.
brevomcp_pipelines_get_crm_pipeline_details_by_pipeline_idRetrieve the details of a specific deal pipeline by its identifier, including its stages and their win probabilities.Read-onlyPipelines 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.
Inputs
pipelineIDstringrequired- ID of the pipeline to retrieve
brevomcp_processes_get_processRetrieves detailed information about a specific background process.Read-onlyProcesses Get Process
Retrieves detailed information about a specific background process.
Inputs
processIdintegerrequired- Id of the process
brevomcp_processes_get_processesRetrieves a list of background processes from your Brevo account with filtering and pagination.Read-onlyProcesses Get Processes
Retrieves a list of background processes from your Brevo account with filtering and pagination.
Inputs
limitstring- Number limitation for the result returned
offsetstring- Beginning point in the list to retrieve from.
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_products_get_product_infoRetrieve the full details of a single ecommerce product by its unique ID.Read-onlyProducts 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.
Inputs
idstringrequired- Product ID
brevomcp_products_get_productsRetrieve a paginated list of all ecommerce products stored in your Brevo account.Read-onlyProducts 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.
Inputs
alternativePrice_eqstring- Alternative price filter for products equals to particular amount
alternativePrice_gtstring- Alternative price filter for products greater than particular amount
alternativePrice_gtestring- Alternative price filter for products greater than and equals to particular amount
alternativePrice_ltstring- Alternative price filter for products less than particular amount
alternativePrice_ltestring- Alternative price filter for products less than and equals to particular amount
alternativePrice_nestring- Alternative price filter for products not equals to particular amount
categoriesstring- Filter by categories ids
createdSincestring- Filter (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.
idsstring- Filter by product ids
isDeletedstring- Filter products by their deletion status. If `false` is passed, only products that are not deleted will be returned.
limitstring- Number of documents per page
modifiedSincestring- Filter (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.
namestring- Filter by product name, minimum 3 characters should be present for search.
offsetstring- Index of the first document in the page
price_eqstring- Price filter for products equals to particular amount
price_gtstring- Price filter for products greater than particular amount
price_gtestring- Price filter for products greater than and equals to particular amount
price_ltstring- Price filter for products less than particular amount
price_ltestring- Price filter for products less than and equals to particular amount
price_nestring- Price filter for products not equals to particular amount
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
sortByFieldstring- Sort the results by a specific field. Default sort field is `created_at` when not passed.
brevomcp_segments_get_segmentsRetrieve all contact segments defined in your Brevo account with support for pagination and sorting.Read-onlySegments 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.
Inputs
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
brevomcp_senders_get_sendersRetrieves a list of all email senders from your Brevo account with optional filtering.Read-onlySenders Get Senders
Retrieves a list of all email senders from your Brevo account with optional filtering.
Inputs
domainstring- Filter your senders for a specific domain
ipstring- Filter your senders for a specific ip. Available for dedicated IP usage only
brevomcp_sms_campaigns_get_sms_campaignRetrieve 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.Read-onlySms 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.
Inputs
campaignIdintegerrequired- id of the SMS campaign
brevomcp_sms_campaigns_get_sms_campaignsRetrieve a paginated list of all your SMS campaigns with their statistics and recipient information.Read-onlySms 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.
Inputs
endDatestring- Mandatory 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.
limitstring- Number of documents per page
offsetstring- Beginning point in the list to retrieve from.
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory 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.
statusstring- Status of campaign.
brevomcp_tasks_get_crm_tasksRetrieve a paginated list of CRM tasks with optional filtering by task type, status, date range, assignee, and linked entities (contacts, deals, companies).Read-onlyTasks 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.
Inputs
dateFromstring- dateFrom to date range filter type (timestamp in milliseconds)
dateTostring- dateTo to date range filter type (timestamp in milliseconds)
filter_assignTostring- Filter by the "assignTo" ID. You can utilize account emails for the "assignTo" attribute.
filter_companiesstring- Filter by companies ids
filter_contactsstring- Filter by contact ids
filter_datestring- Filter by date
filter_dealsstring- Filter by deals ids
filter_statusstring- Filter by task status
filter_typestring- Filter by task type (ID)
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
sortstring- Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed
sortBystring- The field used to sort field names.
brevomcp_tasks_get_crm_tasks_by_idRetrieve the full details of a single CRM task by its identifier.Read-onlyTasks 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.
Inputs
idstringrequired- Task ID
brevomcp_tasks_get_crm_tasktypesRetrieve the list of all available task types for your account.Read-onlyTasks 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.
Inputs
This tool takes no inputs.
brevomcp_templates_get_smtp_templateRetrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string.Read-onlyTemplates Get Smtp Template
Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string.
Inputs
templateIdstringrequired- ID 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_templatesRetrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps.Read-onlyTemplates 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.
Inputs
editorTypestring- Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value.
limitstring- Number of documents returned per page
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
templateStatusstring- Filter on the status of the template. Active = true, inactive = false
brevomcp_transac_templates_get_blocked_domainsRetrieve the complete list of domains that have been blocked for transactional email sending.Read-onlyTransac 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.
Inputs
This tool takes no inputs.
brevomcp_transac_templates_get_scheduled_email_by_idFetch 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).Read-onlyTransac 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.
Inputs
identifierstringrequired- The `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.
endDatestring- Mandatory 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.
limitstring- Number of documents returned per page. Not valid when identifier is `messageId`.
offsetstring- Index of the first document on the page. Not valid when identifier is `messageId`.
sortstring- Sort 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`.
startDatestring- Mandatory 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.
statusstring- Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.
brevomcp_transac_templates_get_sms_eventsRetrieve 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.Read-onlyTransac 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.
Inputs
daysstring- Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
endDatestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.
eventstring- Filter the report for specific events
limitstring- Number of documents per page
offsetstring- Index of the first document of the page
phoneNumberstring- Filter the report for a specific phone number
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.
tagsstring- Filter the report for specific tags, passed as a comma-separated URL-encoded string
brevomcp_transac_templates_get_sms_templatesRetrieve a paginated list of all your SMS templates with their content, compliance settings, and media attachments.Read-onlyTransac 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.
Inputs
limitstring- Number of documents returned per page
offsetstring- Index of the first document in the page
sortstring- Sort 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_reportRetrieve 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.Read-onlyTransac 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.
Inputs
daysstring- Number of days in the past including today (positive integer). Not compatible with startDate and endDate
endDatestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.
startDatestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.
tagstring- Filter results by a specific tag
brevomcp_transac_templates_get_transac_blocked_contactsRetrieve a paginated list of transactional contacts that have been blocked or unsubscribed, along with the reason for blocking (e.g.Read-onlyTransac 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).
Inputs
endDatestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts
limitstring- Number of documents returned per page
offsetstring- Index of the first document on the page
sendersstring- Comma separated list of emails of the senders from which contacts are blocked or unsubscribed
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory 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_contentRetrieve the full content and event history of a specific sent transactional email by its unique ID (uuid).Read-onlyTransac Templates Get Transac Email Content
Retrieve the full content and event history of a specific sent transactional email by its unique ID (uuid).
Inputs
uuidstringrequired- Unique id of the transactional email that has been sent to a particular contact
brevomcp_transac_templates_get_transac_emails_listRetrieve a paginated list of sent transactional emails.Read-onlyTransac 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.
Inputs
emailstring- Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
endDatestring- Mandatory 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.
limitstring- Number of documents returned per page
messageIdstring- Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory 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.
templateIdstring- Mandatory 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_reportRetrieve 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.Read-onlyTransac 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.
Inputs
daysstring- Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
endDatestring- Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report. Must not be in the future.
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report. Must not be in the future and must not be after endDate.
tagstring- Filter results by a specific tag
brevomcp_users_get_invited_users_listRetrieves the list of all users associated with your organization, including both active and pending invited users.Read-onlyUsers 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.
Inputs
This tool takes no inputs.
brevomcp_users_get_user_permissionRetrieves the granular feature-level permissions assigned to a specific user in the organization, identified by their email address.Read-onlyUsers 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.
Inputs
emailstringrequired- Email of the invited user.
brevomcp_webhooks_management_get_webhookRetrieves detailed information about a specific webhook configuration.Read-onlyWebhooks Management Get Webhook
Retrieves detailed information about a specific webhook configuration.
Inputs
webhookIdintegerrequired- Id of the webhook
brevomcp_webhooks_management_get_webhooksRetrieves all webhooks from your Brevo account with filtering and sorting options.Read-onlyWebhooks 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.
Inputs
sortstring- Sort the results in the ascending/descending order of webhook creation
typestring- Filter on webhook type
brevomcp_whatsapp_campaigns_get_whats_app_campaignRetrieve detailed information about a specific WhatsApp campaign by its ID, including campaign status, recipients, sender number, template details, and delivery statistics.Read-onlyWhatsapp 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.
Inputs
campaignIdintegerrequired- Id of the campaign
brevomcp_whatsapp_campaigns_get_whats_app_campaignsRetrieve a paginated list of all your WhatsApp campaigns with their statistics and metadata.Read-onlyWhatsapp 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.
Inputs
endDatestring- Mandatory 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
limitstring- Number of documents per page
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed
startDatestring- Mandatory 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_configRetrieve 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.Read-onlyWhatsapp 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.
Inputs
This tool takes no inputs.
brevomcp_whatsapp_campaigns_get_whats_app_templatesRetrieve a paginated list of all your WhatsApp templates with their status, category, language, and metadata.Read-onlyWhatsapp 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.
Inputs
endDatestring- Mandatory 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
limitstring- Number of documents per page
offsetstring- Index of the first document in the page
sortstring- Sort the results in the ascending/descending order of record modification. Default order is descending if `sort` is not passed
sourcestring- source of the template
startDatestring- Mandatory 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_management_get_whatsapp_event_reportRetrieve 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.Read-onlyWhatsapp 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.
Inputs
contactNumberstring- Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)
daysstring- Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_
endDatestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
eventstring- Filter the report for a specific event type
limitstring- Number limitation for the result returned
offsetstring- Beginning point in the list to retrieve from
sortstring- Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed
startDatestring- Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
brevomcp_accounts_invite_admin_userInvites a new member to manage the Admin (master) account by sending an invitation email.WriteAccounts Invite Admin User
Invites a new member to manage the Admin (master) account by sending an invitation email.
Inputs
all_features_accessstringrequired- All access to the features
emailstringrequired- Email address for the organization
privilegesstringrequired- No description.
groupIdsstring- Ids of Group
brevomcp_accounts_post_corporate_sso_tokenGenerates a Single Sign-On (SSO) token that allows authentication to the corporate admin account without requiring a separate login.WriteAccounts 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].
Inputs
emailstringrequired- User email of admin account
brevomcp_accounts_post_corporate_sub_accountCreates a new sub-account under the corporate master account.WriteAccounts 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.
Inputs
companyNamestringrequired- Set the name of the sub-account company
emailstringrequired- Email address for the organization
groupIdsstring- Set the group(s) for the sub-account
languagestring- Set the language of the sub-account
timezonestring- Set the timezone of the sub-account
brevomcp_accounts_post_corporate_sub_account_ip_associateAssociates a dedicated IP address with one or more sub-account organizations.WriteAccounts 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.
Inputs
idsstringrequired- Pass the list of sub-account Ids to be associated with the IP address
ipstringrequired- IP address
brevomcp_accounts_post_corporate_sub_account_keyGenerates a new API v3 key for a specific sub-account organization.WriteAccounts 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.
Inputs
idintegerrequired- Id of the sub-account organization
namestringrequired- Name of the API key
brevomcp_accounts_post_corporate_sub_account_sso_tokenGenerates a Single Sign-On (SSO) token that allows the master account to authenticate directly into a sub-account without requiring separate login credentials.WriteAccounts 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].
Inputs
idintegerrequired- Id of the sub-account organization
emailstring- User email of sub-account organization
targetstring- Set 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
urlstring- Set 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_toggleEnables or disables specific applications for a sub-account organization.WriteAccounts 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.
- Idempotent
Inputs
idintegerrequired- Id of the sub-account organization (mandatory)
automationstring- Set this field to enable or disable Automation on the sub-account
conversationsstring- Set this field to enable or disable Conversations on the sub-account
crmstring- Set this field to enable or disable Sales CRM on the sub-account
email_campaignsstring- Set this field to enable or disable Email Campaigns on the sub-account
facebook_adsstring- Set this field to enable or disable Facebook ads on the sub-account
inboxstring- Set this field to enable or disable Inbox on the sub-account / Not applicable on ENTv2
landing_pagesstring- Set this field to enable or disable Landing pages on the sub-account
meetingsstring- Set this field to enable or disable Meetings on the sub-account
sms_campaignsstring- Set this field to enable or disable SMS Marketing on the sub-account
transactional_emailsstring- Set this field to enable or disable Transactional Email on the sub-account
transactional_smsstring- Set this field to enable or disable Transactional SMS on the sub-account
web_pushstring- Set this field to enable or disable Web Push on the sub-account
whatsappstring- Set this field to enable or disable Whatsapp campaigns on the sub-account
brevomcp_accounts_put_corporate_sub_account_ip_dissociateRemoves the association of a dedicated IP address from one or more sub-account organizations.WriteAccounts 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.
- Idempotent
Inputs
idsstringrequired- Pass the list of sub-account Ids to be dissociated from the IP address
ipstringrequired- IP address
brevomcp_accounts_put_corporate_sub_account_planUpdates the plan configuration for a specific sub-account, including credit allocations (email, SMS, WhatsApp, push) and feature quotas (users, landing pages, inbox, sales users).WriteAccounts 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.
- Idempotent
Inputs
idintegerrequired- Id of the sub-account organization
creditsstring- Credit details to update
featuresstring- Features details to update
brevomcp_accounts_put_corporate_sub_accounts_planUpdates the plan configuration for multiple sub-accounts at once with the same credit allocations and feature quotas.WriteAccounts 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.
- Idempotent
Inputs
creditsstring- Credit details to update
featuresstring- Features details to update
subAccountIdsstring- List of sub-account ids
brevomcp_accounts_put_corporate_user_invitation_by_emailAllows you to resend or cancel a pending invitation for an admin user.WriteAccounts 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`.
- Idempotent
Inputs
actionstringrequired- Action to be performed (cancel / resend)one of
resendcancel emailstringrequired- Email address of the recipient
brevomcp_accounts_put_corporate_user_permissionsUpdates the feature-level permissions for an existing admin user of your master account, identified by their email address.WriteAccounts 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.
- Idempotent
Inputs
all_features_accessstringrequired- All access to the features
emailstringrequired- Email address of Admin user
privilegesstringrequired- No description.
brevomcp_attributes_create_attributeCreate a new contact attribute under the specified category and name.WriteAttributes Create Attribute
Create a new contact attribute under the specified category and name.
Inputs
attributeCategorystringrequired- Category of the attributeone of
normaltransactionalcategorycalculatedglobal attributeNamestringrequired- Name of the attribute
enumerationstring- List 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"}]
isRecurringstring- Type of the attribute. Use only if the attribute's category is 'calculated' or 'global'
multiCategoryOptionsstring- List 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"]
typestring- Type 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
valuestring- Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'
brevomcp_attributes_patch_crm_attributes_by_idUpdate an existing custom attribute's label or options.WriteAttributes 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.
Inputs
idstringrequired- Attribute ID
labelstring- Attribute display label (max 50 characters)
objectTypestring- The type of object the attribute belongs to, it cannot be updated after creation
optionsLabelsstring- Updated labels for selectable options
brevomcp_attributes_post_crm_attributesCreate a new custom attribute for companies or deals.WriteAttributes 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.
Inputs
attributeTypestringrequired- The type of attribute (must be one of the defined enums)one of
textusernumbersingle-selectdatebooleanmulti-choice labelstringrequired- The label for the attribute (max 50 characters, cannot be empty)
objectTypestringrequired- The type of object the attribute belongs to. Must be either `companies` or `deals`.one of
companiesdeals descriptionstring- A description of the attribute
optionsLabelsstring- Options for multi-choice or single-select attributes
brevomcp_attributes_update_attributeUpdate an existing contact attribute identified by its category and name.WriteAttributes 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.
- Idempotent
Inputs
attributeCategorystringrequired- Category of the attributeone of
categorycalculatedglobalnormal attributeNamestringrequired- Name of the existing attribute
enumerationstring- List 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"}]
multiCategoryOptionsstring- Use 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"]
valuestring- Value of the attribute to update. Use only if the attribute's category is 'calculated' or 'global'
brevomcp_categories_create_update_batch_categoryCreate or update multiple ecommerce categories in a single request.WriteCategories 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.
Inputs
categoriesstringrequired- array of categories objects
updateEnabledstring- Facilitate to update the existing categories in the same request (updateEnabled = true)
brevomcp_categories_create_update_categoryCreate a new ecommerce category or update an existing one, identified by the mandatory `id` field.WriteCategories 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.
Inputs
idstringrequired- Unique Category ID as saved in the shop
deletedAtstring- UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted from the shop's database
isDeletedstring- category deleted from the shop's database
namestring- Mandatory in case of creation. Name of the Category, as displayed in the shop
updateEnabledstring- Facilitate to update the existing category in the same request (updateEnabled = true)
urlstring- URL to the category
brevomcp_companies_patch_by_idUpdate an existing company's attributes, name, linked contacts, or linked deals.WriteCompanies 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.
Inputs
idstringrequired- No description.
attributesstring- Attributes for company update
countryCodestring- Country code if phone_number is passed in attributes.
linkedContactsIdsstring- Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
linkedDealsIdsstring- Warning - Using PATCH on linkedDealsIds replaces the list of linked deals. Omitted IDs will be removed.
namestring- Name of company
brevomcp_companies_patch_link_unlink_by_idLink or unlink contacts and deals with a specific company in a single request.WriteCompanies 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.
Inputs
idstringrequired- ID of the company to link or unlink entities with
linkContactIdsstring- Contact IDs for contacts to be linked with the company
linkDealsIdsstring- Deal IDs for deals to be linked with the company
unlinkContactIdsstring- Contact IDs for contacts to be unlinked from the company
unlinkDealsIdsstring- Deal IDs for deals to be unlinked from the company
brevomcp_companies_post_companiesCreate a new CRM company with the specified name, attributes, and optional associations to contacts and deals.WriteCompanies 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.
Inputs
namestringrequired- Name of company
attributesstring- Attributes for company creation
countryCodestring- Country code if phone_number is passed in attributes.
linkedContactsIdsstring- Contact ids to be linked with company
linkedDealsIdsstring- Deal ids to be linked with company
brevomcp_companies_post_importImport companies in bulk from a CSV file with configurable mapping options.WriteCompanies 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.
Inputs
This tool takes no inputs.
brevomcp_contact_import_export_create_doi_contactCreate a contact using the Double Opt-In (DOI) flow.WriteContact 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.
Inputs
emailstringrequired- Email address where the confirmation email will be sent. This email address will be the identifier for all other contact attributes.
includeListIdsstringrequired- Lists under user account where contact should be added
redirectionUrlstringrequired- URL 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 }}.
templateIdintegerrequired- Id of the Double opt-in (DOI) template
attributesstring- Pass 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']}
excludeListIdsstring- Lists under user account where contact should not be added
brevomcp_contact_import_export_import_contactsImport contacts into your Brevo account from a CSV file body, a JSON body, or a remote file URL.WriteContact 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.
Inputs
disableNotificationstring- To disable email notification
emailBlackliststring- To blacklist all the contacts for email
emptyContactsAttributesstring- To 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 )
fileBodystring- Mandatory 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.
fileUrlstring- Mandatory if fileBody and jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: #### .txt, .csv, .json
jsonBodystring- Mandatory 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.
listIdsstring- Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].
newListstring- To create a new list and import the contacts into it, pass the listName and an optional folderId.
notifyUrlstring- URL that will be called once the import process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
smsBlackliststring- To blacklist all the contacts for sms
updateExistingContactsstring- To facilitate the choice to update the existing contacts
brevomcp_contact_import_export_request_contact_exportExport contacts from your Brevo account based on custom filters.WriteContact 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.
Inputs
customContactFilterstringrequired- Set the filter for the contacts to be exported.
disableNotificationstring- To avoid generating the email notification upon contact export, pass true
exportAttributesstring- List 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']
exportDateInUTCstring- Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format.
exportMandatoryAttributesstring- To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME
exportMetadatastring- Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.
exportSubscriptionStatusstring- Export 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.
notifyUrlstring- Webhook 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_contactsUpdate multiple contacts in a single API call by passing an array of contact objects, with a maximum of 100 contacts per request.WriteContact 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.
Inputs
contactsstringrequired- List of contacts to be updated
brevomcp_contacts_create_contactCreates new contacts on Brevo.WriteContacts 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.
Inputs
attributesstring- Pass 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"]}
emailstring- Email address of the user. Mandatory if "ext_id" & "SMS" field is not passed.
emailBlacklistedstring- Set this field to blacklist the contact for emails (emailBlacklisted = true)
ext_idstring- Pass your own Id to create a contact.
listIdsstring- Ids of the lists to add the contact to
smsBlacklistedstring- Set this field to blacklist the contact for SMS (smsBlacklisted = true)
smtpBlacklistSenderstring- transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
updateEnabledstring- Facilitate to update the existing contact in the same request (updateEnabled = true)
brevomcp_contacts_update_contactUpdate an existing contact identified by their email address, numeric ID, or other identifier.WriteContacts 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.
- Idempotent
Inputs
identifierstringrequired- Email (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
attributesstring- Pass 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"}
emailBlacklistedstring- Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)
ext_idstring- Pass your own Id to update ext_id of a contact.
identifierTypestring- email_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
listIdsstring- Ids of the lists to add the contact to
smsBlacklistedstring- Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)
smtpBlacklistSenderstring- transactional email forbidden sender for contact. Use only for email Contact
unlinkListIdsstring- Ids of the lists to remove the contact from
brevomcp_conversations_post_agent_online_pingSets the agent's status to online for 2-3 minutes.WriteConversations 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.
Inputs
agentEmailstring- Agent'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.
agentGroupsstring- An 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.
agentIdstring- Agent 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).
agentNamestring- Agent's name.
receivedFromstring- Mark your messages to distinguish messages created by you from the others.
brevomcp_conversations_post_messagesSend a message as an agent to an existing visitor's conversation.WriteConversations 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.
Inputs
textstringrequired- Message text.
visitorIdstringrequired- Visitor'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>.
agentEmailstring- Agent'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.
agentIdstring- Agent 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).
agentNamestring- Agent's name.
receivedFromstring- Mark 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_messagesSend an automated (pushed) message to one or more visitors on behalf of an agent.WriteConversations 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`.
Inputs
textstringrequired- Message text.
agentIdstring- Agent 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.
groupIdstring- Group 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`.
receivedFromstring- Mark 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.
visitorIdstring- Visitor'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.
visitorIdsstring- An 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_idUpdate the text of a message sent by an agent.WriteConversations 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.
- Idempotent
Inputs
idstringrequired- ID of the message
textstringrequired- The new message text.
brevomcp_conversations_put_pushed_messages_by_idUpdate the text of an automated (pushed) message.WriteConversations 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.
- Idempotent
Inputs
idstringrequired- ID of the message
textstringrequired- The new message text.
brevomcp_coupons_create_coupon_collectionCreate a new coupon collection with a name and a default coupon value.WriteCoupons 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.
Inputs
defaultCouponstringrequired- Default coupons collection name
namestringrequired- Name of the coupons collection
expirationDatestring- Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
remainingCouponsAlertstring- Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
remainingDaysAlertstring- Send 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_couponsAdd coupons to an existing coupon collection.WriteCoupons 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.
Inputs
collectionIdstringrequired- The id of the coupon collection for which the coupons will be created
couponsstringrequired- No description.
brevomcp_coupons_update_coupon_collectionUpdate an existing coupon collection by its UUID.WriteCoupons 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.
Inputs
idstringrequired- Id of the collection to update
defaultCouponstring- A default coupon to be used in case there are no coupons left
expirationDatestring- Specify an expiration date for the coupon collection in RFC3339 format. Use null to remove the expiration date.
remainingCouponsAlertstring- Send a notification alert (email) when the remaining coupons count is equal or fall bellow this number. Use null to disable alerts.
remainingDaysAlertstring- Send 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_patch_crm_deals_by_idUpdate an existing deal's name or attributes.WriteDeals 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.
Inputs
idstringrequired- No description.
attributesstring- Attributes 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}`
namestring- Name of deal
brevomcp_deals_patch_crm_deals_link_unlink_by_idLink or unlink contacts and companies with a specific deal in a single request.WriteDeals 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.
Inputs
idstringrequired- ID of the deal to link or unlink entities with
linkCompanyIdsstring- Company IDs to be linked with the deal
linkContactIdsstring- Contact IDs for contacts to be linked with the deal
unlinkCompanyIdsstring- Company IDs to be unlinked from the deal
unlinkContactIdsstring- Contact IDs for contacts to be unlinked from the deal
brevomcp_deals_post_crm_dealsCreate a new deal in the CRM with the specified name, attributes, and optional associations to contacts and companies.WriteDeals 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.
Inputs
namestringrequired- Name of deal
attributesstring- Attributes 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}`
linkedCompaniesIdsstring- Company ids to be linked with deal
linkedContactsIdsstring- Contact ids to be linked with deal
brevomcp_deals_post_crm_deals_importImport deals in bulk from a CSV file with configurable mapping options.WriteDeals 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.
Inputs
This tool takes no inputs.
brevomcp_domains_authenticate_domainAuthenticates a specific domain.WriteDomains Authenticate Domain
Authenticates a specific domain.
- Idempotent
Inputs
domainNamestringrequired- Domain name
brevomcp_domains_create_domainCreates a new domain in Brevo.WriteDomains Create Domain
Creates a new domain in Brevo.
Inputs
namestringrequired- Domain name to be added
brevomcp_ecommerce_create_batch_orderCreate or update multiple ecommerce orders in a single asynchronous batch request.WriteEcommerce 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).
Inputs
ordersstringrequired- array of order objects
historicalstring- Defines 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.
notifyUrlstring- Webhook URL to receive the status of the batch request
brevomcp_ecommerce_create_orderCreate a new ecommerce order or update the status of an existing order.WriteEcommerce 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.
Inputs
amountnumberrequired- Total amount of the order, including all shipping expenses, tax and the price of items.
createdAtstringrequired- Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.
idstringrequired- Unique ID of the order.
productsstringrequired- No description.
statusstringrequired- State of the order.
updatedAtstringrequired- Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.
billingstring- Billing details of an order.
couponsstring- Coupons applied to the order. Stored case insensitive.
identifiersstring- Identifies the contact associated with the order.
metaInfostring- Meta data of order to store additional detail such as custom message, customer type, source.
storeIdstring- ID of store where the order is placed
brevomcp_ecommerce_post_activateActivate the Brevo eCommerce application for your account.WriteEcommerce 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.
Inputs
This tool takes no inputs.
brevomcp_ecommerce_set_config_display_currencySet or update the ISO 4217 display currency code for your Brevo ecommerce account.WriteEcommerce 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.
Inputs
codestringrequired- ISO 4217 compliant display currency code
brevomcp_email_campaign_management_create_email_campaignCreate a new email campaign.WriteEmail 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.
Inputs
namestringrequired- Name of the campaign
senderstringrequired- Sender 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}
abTestingstring- Status 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
attachmentUrlstring- Absolute 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
emailExpirationDatestring- To 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``
footerstring- Footer of the email campaign
headerstring- Header of the email campaign
htmlContentstring- Mandatory 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`.
htmlUrlstring- Mandatory 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
increaseRatestring- Mandatory 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%.
initialQuotastring- Mandatory 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.
inlineImageActivationstring- Use 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_
ipWarmupEnablestring- Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
mirrorActivestring- Use true to enable the mirror link
paramsstring- Pass 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
previewTextstring- Preview text or preheader of the email campaign
recipientsstring- Segment ids and List ids to include/exclude from campaign
replyTostring- Email on which the campaign recipients will be able to reply to
scheduledAtstring- Sending 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
sendAtBestTimestring- Set this to true if you want to send your campaign at best time.
splitRulestring- Add 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
subjectstring- Subject of the campaign. Mandatory if abTesting is false. Ignored if abTesting is true.
subjectAstring- Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
subjectBstring- Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
tagstring- Tag of the campaign
templateIdstring- Mandatory 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`.
toFieldstring- To 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
unsubscriptionPageIdstring- Enter 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.
updateFormIdstring- Mandatory 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.
utmCampaignstring- Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
winnerCriteriastring- Choose the metrics that will determinate the winning version. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerCriteria` is ignored if passed
winnerDelaystring- Choose 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_email_export_recipientsExport the recipients of a sent email campaign as an asynchronous process, filtered by recipient type (e.g.WriteEmail 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.
Inputs
campaignIdintegerrequired- Id of the campaign
recipientsTypestringrequired- Type of recipients to export for a campaignone of
allnonClickersnonOpenersclickersopenerssoftBounceshardBouncesunsubscribed notifyURLstring- Webhook called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479
brevomcp_email_campaign_management_send_email_campaign_nowSend an existing email campaign immediately by scheduling it for the current time.WriteEmail 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.
Inputs
campaignIdintegerrequired- Id of the campaign
brevomcp_email_campaign_management_send_reportSend a PDF report of an email campaign to the specified email addresses.WriteEmail 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.
Inputs
campaignIdintegerrequired- Id of the campaign
emailstringrequired- Custom attributes for the report email.
languagestring- Language of email content for campaign report sending.
brevomcp_email_campaign_management_send_test_emailSend a test version of an email campaign to specified email addresses or your entire test list.WriteEmail 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.
Inputs
campaignIdintegerrequired- Id of the campaign
emailTostring- List 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_statusUpdate the status of an email campaign, such as suspending, archiving, or replicating it.WriteEmail 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.
- Idempotent
Inputs
campaignIdintegerrequired- Id of the campaign
statusstring- Note:- replicateTemplate status will be available only for template type campaigns.
brevomcp_email_campaign_management_update_email_campaignUpdate an existing email campaign's properties such as name, subject, content, sender, recipients, schedule, and A/B testing configuration.WriteEmail 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.
- Idempotent
Inputs
campaignIdintegerrequired- Id of the campaign
abTestingstring- Status 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
attachmentUrlstring- Absolute 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'
emailExpirationDatestring- To 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.
footerstring- Footer of the email campaign
headerstring- Header of the email campaign
htmlContentstring- Body 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
htmlUrlstring- Url which contents the body of the email message. REQUIRED if htmlContent is empty
increaseRatestring- 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%.
initialQuotastring- Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000.
inlineImageActivationstring- Status 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_.
ipWarmupEnablestring- Available for dedicated ip clients. Set this to true if you wish to warm up your ip.
mirrorActivestring- Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
namestring- Name of the campaign
paramsstring- Pass 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
previewTextstring- Preview text or preheader of the email campaign
recipientsstring- Segment ids and List ids to include/exclude from campaign
recurringstring- FOR 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
replyTostring- Email on which campaign recipients will be able to reply to
scheduledAtstring- UTC 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).
sendAtBestTimestring- Set this to true if you want to send your campaign at best time. Note:- if true, warmup ip will be disabled.
senderstring- Sender 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}
splitRulestring- Add 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
subjectstring- Subject of the campaign
subjectAstring- Subject A of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
subjectBstring- Subject B of the campaign. Mandatory if abTesting = true. subjectA & subjectB should have unique value
tagstring- Tag of the campaign
toFieldstring- To 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
unsubscriptionPageIdstring- Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
updateFormIdstring- Mandatory 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.
utmCampaignstring- Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed
winnerCriteriastring- Choose the metrics that will determinate the winning version. Mandatory if _splitRule_ >= 1 and < 50. If splitRule = 50, `winnerCriteria` is ignored if passed
winnerDelaystring- Choose 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_galleryUpload an image to your account's image gallery by providing an absolute URL to the image.WriteEmail 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.
Inputs
imageUrlstringrequired- The 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.
namestring- Name of the image.
brevomcp_events_create_eventCreate a single event to record a contact's interaction.WriteEvents 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.
Inputs
event_namestringrequired- The 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.
identifiersstringrequired- Identifies the contact associated with the event. At least one identifier is required. Each identifier value is limited to 255 characters.
contact_propertiesstring- Properties 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_datestring- ISO 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_propertiesstring- Properties 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.
objectstring- Identifiers 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_external_feeds_create_external_feedCreates a new external feed for dynamic content in email campaigns.WriteExternal Feeds Create External Feed
Creates a new external feed for dynamic content in email campaigns.
Inputs
namestringrequired- Name of the feed
urlstringrequired- URL of the external data source
authTypestring- Authentication type for accessing the feed
cachestring- Whether to cache the feed response
headersstring- Custom HTTP headers for the feed request
maxRetriesstring- Maximum number of retry attempts for failed requests
passwordstring- Password for basic authentication (required if authType is 'basic')
tokenstring- Token for token-based authentication (required if authType is 'token')
usernamestring- Username for basic authentication (required if authType is 'basic')
brevomcp_external_feeds_update_external_feedUpdates configuration of an existing external feed.WriteExternal Feeds Update External Feed
Updates configuration of an existing external feed.
- Idempotent
Inputs
uuidstringrequired- UUID of the feed to update
authTypestring- Authentication type for accessing the feed
cachestring- Whether to cache the feed response
headersstring- Custom HTTP headers for the feed request. New headers are merged with existing ones (matching names are replaced).
maxRetriesstring- Maximum number of retry attempts for failed requests
namestring- Name of the feed
passwordstring- Password for basic authentication
tokenstring- Token for token-based authentication
urlstring- URL of the external data source
usernamestring- Username for basic authentication
brevomcp_files_post_crm_filesUpload a file and associate it with a contact, company, or deal.WriteFiles 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.
Inputs
This tool takes no inputs.
brevomcp_folders_create_folderCreate a new folder to organize your contact lists.WriteFolders 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.
Inputs
namestringrequired- Name of the folder
brevomcp_folders_update_folderUpdate the name of an existing folder identified by its ID.WriteFolders 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.
- Idempotent
Inputs
folderIdintegerrequired- Id of the folder
namestringrequired- Name of the folder
brevomcp_groups_post_corporate_groupCreates a new group to organize sub-accounts under the corporate master account.WriteGroups 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.
Inputs
groupNamestringrequired- The name of the group of sub-accounts
subAccountIdsstring- Pass the list of sub-account Ids to be included in the group
brevomcp_groups_put_corporate_group_by_idUpdates the details of an existing group of sub-accounts, including the group name and the list of sub-accounts assigned to it.WriteGroups 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.
- Idempotent
Inputs
idstringrequired- Id of the group
groupNamestring- The name of the group of sub-accounts
subAccountIdsstring- Pass the list of sub-account Ids to be included in the group
brevomcp_groups_put_corporate_group_unlink_sub_accountsRemoves one or more sub-organizations from a specific group.WriteGroups 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.
- Idempotent
Inputs
groupIdstringrequired- Group id
subAccountIdsstringrequired- List of sub-account ids to remove from the group
brevomcp_lists_add_contact_to_listAdd existing contacts to a specific list by providing their email addresses, numeric IDs, or EXT_ID attributes.WriteLists 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.
Inputs
listIdintegerrequired- Id of the list
emailsstring- Emails 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._
extIdsstring- EXT_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._
idsstring- IDs 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_listCreate a new contact list inside a specified folder.WriteLists 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.
Inputs
folderIdintegerrequired- Id of the parent folder in which this list is to be created
namestringrequired- Name of the list
brevomcp_lists_remove_contact_from_listRemove 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.WriteLists 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.
Inputs
listIdintegerrequired- Id of the list
allstring- Required 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
emailsstring- Required 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.
extIdsstring- Required 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.
idsstring- Required 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_listUpdate an existing contact list identified by its ID.WriteLists 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.
- Idempotent
Inputs
listIdintegerrequired- Id of the list
folderIdstring- Id of the folder in which the list is to be moved. Either of the two parameters (name, folderId) can be updated at a time.
namestring- Name of the list. Either of the two parameters (name, folderId) can be updated at a time.
brevomcp_loyalty_add_subscription_to_tierManually assigns a tier to a contact's subscription in a loyalty program.WriteLoyalty 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.
Inputs
cidintegerrequired- Contact ID
pidstringrequired- Loyalty Program ID
tidstringrequired- Tier ID
brevomcp_loyalty_begin_transactionCreates a new balance transaction (credit or debit) within a loyalty program.WriteLoyalty 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.
Inputs
amountnumberrequired- Transaction amount. A positive value creates a credit transaction and a negative value creates a debit transaction (unless transactionType is explicitly provided).
balanceDefinitionIdstringrequired- Unique identifier (UUID) of the associated balance definition.
pidstringrequired- Loyalty Program Id
autoCompletestring- Whether the transaction should be automatically completed.
balanceExpiryInMinutesstring- Expiry time for the balance in minutes. Must be greater than 0 if provided. Only applicable when autoComplete is true.
contactIdstring- Unique identifier of the contact involved in the transaction. Required unless `LoyaltySubscriptionId` is provided.
eventTimestring- Timestamp specifying when the transaction event occurred (ISO 8601 / RFC 3339 format).
LoyaltySubscriptionIdstring- Unique identifier for the loyalty subscription. Required unless `contactId` is provided.
metastring- Optional metadata associated with the transaction.
transactionTypestring- Explicit transaction type. If not provided, the type is inferred from the sign of the amount (positive = credit, negative = debit).
ttlstring- Time-to-live for the transaction in seconds. Must be at least 10 seconds if provided.
brevomcp_loyalty_cancel_transactionCancels a pending transaction, reverting any tentative balance changes.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program Id
tidstringrequired- Transaction Id
brevomcp_loyalty_complete_redeem_transactionCompletes a pending voucher redemption request.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
tidstringrequired- Redeem transaction ID
brevomcp_loyalty_complete_transactionCompletes a pending transaction, finalizing the balance change.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program Id
tidstringrequired- Transaction Id
brevomcp_loyalty_create_balance_limitCreates a new limit on a balance definition to restrict transaction frequency or amount within a time window.WriteLoyalty 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.
Inputs
bdidstringrequired- Balance Definition Id
constraintTypestringrequired- Defines whether the limit applies to transaction count or amount.one of
transactionamount durationUnitstringrequired- Unit of time for which the limit is applicable.one of
hourdayweekmonthyear durationValueintegerrequired- Number of time units for the balance limit. Must be greater than zero.
pidstringrequired- Loyalty Program Id
transactionTypestringrequired- Specifies whether the limit applies to credit or debit transactions.one of
creditdebit valueintegerrequired- Maximum allowed value for the specified constraint type. Must be greater than zero.
slidingSchedulestring- Determines if the limit resets on a rolling schedule.
brevomcp_loyalty_create_balance_orderCreates a new balance order linked to a specific balance definition and contact.WriteLoyalty 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.
Inputs
amountnumberrequired- Order amount (must be non-zero).
balanceDefinitionIdstringrequired- Unique identifier (UUID) of the associated balance definition.
contactIdintegerrequired- Unique identifier of the contact placing the order (must be ≥ 1).
dueAtstringrequired- RFC3339 timestamp specifying when the order is due.
pidstringrequired- Loyalty Program Id
sourcestringrequired- Specifies the origin of the order.one of
engineuser expiresAtstring- Optional RFC3339 timestamp defining order expiration.
metastring- Optional metadata associated with the order.
brevomcp_loyalty_create_new_lpCreates a new loyalty program for the organization.WriteLoyalty 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.
Inputs
namestringrequired- Required name of the loyalty program (max 128 chars).
descriptionstring- Optional description of the loyalty program (max 256 chars).
documentIdstring- Optional unique document ID.
metastring- Optional metadata related to the loyalty program.
brevomcp_loyalty_create_rewardCreates a new reward (offer) in a loyalty program.WriteLoyalty 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.
Inputs
namestringrequired- Internal name of the reward
pidstringrequired- Loyalty Program ID
publicDescriptionstring- Public facing description of the reward
publicImagestring- URL of the public image for the reward
publicNamestring- Public facing name of the reward
brevomcp_loyalty_create_tier_for_tier_groupCreates a new tier within a tier group.WriteLoyalty 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.
Inputs
accessConditionsstringrequired- No description.
gidstringrequired- Tier group ID
namestringrequired- Name of the tier to be created
pidstringrequired- Loyalty Program ID
imageRefstring- Image of the tier
tierRewardsstring- No description.
brevomcp_loyalty_create_tier_groupCreates a new tier group in a loyalty program.WriteLoyalty 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.
Inputs
namestringrequired- Name of the tier group
pidstringrequired- Loyalty Program ID
downgradeSchedulestring- Schedule configuration for tier downgrades. Required when downgradeStrategy is set to a schedule-based strategy.
downgradeStrategystring- Select 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.
metastring- Additional metadata for the tier group.
tierOrderstring- Order of the tiers in the group in ascending order
upgradeSchedulestring- Schedule configuration for tier upgrades. Required when upgradeStrategy is set to a schedule-based strategy.
upgradeStrategystring- Select 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_voucherCreates a voucher and attributes it to a specific membership.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
rewardIdstringrequired- Reward id
codestring- Code generated to attribute reward to a contact
contactIdstring- Contact to attribute the reward
expirationDatestring- Reward expiration date
loyaltySubscriptionIdstring- One of contactId or loyaltySubscriptionId is required
metastring- Offer meta information (key/value object)
validFromstring- Date 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.
valuestring- Value of the selected reward config
brevomcp_loyalty_partially_update_loyalty_programPartially updates a loyalty program.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
birthdayAttributestring- Contact attribute name used for birthday tracking (max 128 characters).
descriptionstring- Loyalty program description (max 256 characters).
documentIdstring- Optional document identifier.
metastring- Loyalty program metadata.
namestring- Loyalty program name (max 128 characters).
brevomcp_loyalty_post_balance_programs_balance_definitionsCreates a new balance definition within a loyalty program.WriteLoyalty 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.
Inputs
namestringrequired- Name of the balance definition.
pidstringrequired- Loyalty Program Id
unitstringrequired- Unit of balance measurement.one of
POINTSEURUSDMXNGBPINRCADSGDRONJPYMYRCLPPENMADAUDCHFBRL balanceAvailabilityDurationModifierstring- Defines when the balance expires within the selected duration.
balanceAvailabilityDurationUnitstring- Unit of time for balance validity.
balanceAvailabilityDurationValuestring- Number of time units before the balance expires.
balanceExpirationDatestring- Fixed expiration date (`dd/mm` format) as an alternative to duration-based expiry. Cannot be combined with duration-based availability fields.
balanceOptionAmountOvertakingStrategystring- Defines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundingstring- Defines rounding strategy for credit transactions.
balanceOptionDebitRoundingstring- Defines rounding strategy for debit transactions.
descriptionstring- Short description of the balance definition.
imageRefstring- URL of an optional image reference.
maxAmountstring- Maximum allowable balance amount.
maxCreditAmountLimitstring- Maximum credit allowed per operation.
maxDebitAmountLimitstring- Maximum debit allowed per operation.
metastring- Additional metadata for the balance definition.
minAmountstring- Minimum allowable balance amount.
brevomcp_loyalty_post_balance_programs_subscriptions_balancesCreates a new balance entry for a contact's subscription, linked to a specific balance definition.WriteLoyalty 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.
Inputs
balanceDefinitionIdstringrequired- Unique identifier (UUID) of the balance definition associated with the new balance.
cidstringrequired- Contact Id
pidstringrequired- Loyalty Program Id
brevomcp_loyalty_publish_loyalty_programPublishes the current draft version of a loyalty program, making all pending changes (balance definitions, tiers, tier groups, rewards) live.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
brevomcp_loyalty_redeem_voucherCreates a redemption request for a voucher.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
attributedRewardIdstring- Unique identifier for the attributed reward
autoCompletestring- Whether the redemption should be automatically completed
codestring- Redemption code for the reward
contactIdstring- Unique identifier for the contact
loyaltySubscriptionIdstring- Identifier for the loyalty subscription
metastring- Additional metadata associated with the redeem request
orderstring- Order details for the redemption
rewardIdstring- Unique identifier for the reward
ttlstring- Time to live in seconds for the redemption request
brevomcp_loyalty_subscribe_member_to_a_subscriptionAdds one or more members to an existing subscription.WriteLoyalty 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.
Inputs
memberContactIdsstringrequired- Required, each item must be greater than or equal to 1
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
contactIdstring- Required if LoyaltySubscriptionId is not provided, must be greater than 0
loyaltySubscriptionIdstring- Required if ContactId is not provided, max length 64
brevomcp_loyalty_subscribe_to_loyalty_programCreates a new subscription for a contact in a loyalty program.WriteLoyalty 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).
Inputs
contactIdintegerrequired- Required contact ID; must be greater than 0.
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
creationDatestring- Optional creation date in ISO 8601 format (YYYY-MM-DDThh:mm:ss.ffffff+HH:MM). Must be in the past.
loyaltySubscriptionIdstring- Optional subscription ID (max length 64).
metastring- Optional metadata associated with the subscription.
brevomcp_loyalty_update_balance_definitionReplaces an existing balance definition with the provided data.WriteLoyalty 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.
- Idempotent
Inputs
bdidstringrequired- Balance Definition Id
namestringrequired- Name of the balance definition.
pidstringrequired- Loyalty Program Id
unitstringrequired- Unit of balance measurement.one of
POINTSEURUSDMXNGBPINRCADSGDRONJPYMYRCLPPENMADAUDCHFBRL balanceAvailabilityDurationModifierstring- Defines when the balance expires within the selected duration.
balanceAvailabilityDurationUnitstring- Unit of time for balance validity.
balanceAvailabilityDurationValuestring- Number of time units before the balance expires.
balanceExpirationDatestring- Expiration date (`dd/mm` format) or empty if not applicable.
balanceOptionAmountOvertakingStrategystring- Defines whether partial credit is allowed when reaching max balance.
balanceOptionCreditRoundingstring- Rounding strategy for credit transactions.
balanceOptionDebitRoundingstring- Rounding strategy for debit transactions.
descriptionstring- Short description of the balance definition.
imageRefstring- URL of an optional image reference.
maxAmountstring- Maximum allowable balance amount.
maxCreditAmountLimitstring- Maximum credit allowed per operation.
maxDebitAmountLimitstring- Maximum debit allowed per operation.
metastring- Optional metadata for the balance definition.
minAmountstring- Minimum allowable balance amount.
brevomcp_loyalty_update_balance_limitReplaces an existing balance limit with the provided data.WriteLoyalty 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.
- Idempotent
Inputs
bdidstringrequired- Balance Definition Id
blidstringrequired- Balance Limit Id
constraintTypestringrequired- Defines whether the limit applies to transaction count or amount.one of
transactionamount durationUnitstringrequired- Unit of time for which the limit is applicable.one of
hourdayweekmonthyear durationValueintegerrequired- Number of time units for the balance limit. Must be greater than zero.
pidstringrequired- Loyalty Program Id
transactionTypestringrequired- Specifies whether the limit applies to credit or debit transactions.one of
creditdebit valueintegerrequired- Maximum allowed value for the specified constraint type. Must be greater than zero.
slidingSchedulestring- Determines if the limit resets on a rolling schedule.
brevomcp_loyalty_update_loyalty_programReplaces a loyalty program with the provided data.WriteLoyalty 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.
- Idempotent
Inputs
namestringrequired- Loyalty Program name
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
descriptionstring- Loyalty Program description
metastring- Loyalty Program meta data
brevomcp_loyalty_update_tierReplaces an existing tier's configuration with the provided data.WriteLoyalty 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.
- Idempotent
Inputs
accessConditionsstringrequired- No description.
namestringrequired- Name of the tier to be created
pidstringrequired- Loyalty Program ID
tidstringrequired- Tier ID
tierRewardsstringrequired- No description.
imageRefstring- Image of the tier
brevomcp_loyalty_update_tier_groupReplaces a tier group's configuration with the provided data.WriteLoyalty 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.
- Idempotent
Inputs
downgradeStrategystringrequired- Select 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.one of
real_timemembership_anniversarytier_anniversary gidstringrequired- Tier group ID
namestringrequired- Name of the tier group
pidstringrequired- Loyalty Program ID
tierOrderstringrequired- Order of the tiers in the group in ascending order
upgradeStrategystringrequired- Select 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.one of
real_timemembership_anniversarytier_anniversary metastring- Additional metadata for the tier group.
brevomcp_loyalty_validate_rewardValidates whether a reward can be redeemed for a given contact or subscription.WriteLoyalty 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.
Inputs
pidstringrequired- Loyalty Program ID
attributedRewardIdstring- Unique identifier for the attributed reward
codestring- Validation code for the reward
contactIdstring- Unique identifier for the contact
loyaltySubscriptionIdstring- Identifier for the loyalty subscription
pointOfSellIdstring- Identifier for the point of sale
rewardIdstring- Unique identifier for the reward
brevomcp_notes_patch_crm_notes_by_idUpdate an existing CRM note's text content and its associations with contacts, companies, or deals.WriteNotes 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.
Inputs
idstringrequired- Note ID to update
textstringrequired- Text content of the note. Supports HTML content. Must not be empty and cannot exceed 10,000 characters (excluding HTML tags and line breaks).
companyIdsstring- Company IDs to link to the note
contactIdsstring- Contact IDs to link to the note. For creation, at least one entity (contact, company, or deal) must be provided.
dealIdsstring- Deal IDs to link to the note
isPinnedstring- Whether to pin or unpin the note. Only applicable when updating a note.
brevomcp_notes_post_crm_notesCreate a new CRM note and associate it with at least one contact, company, or deal.WriteNotes 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).
Inputs
textstringrequired- Text content of the note. Supports HTML content. Must not be empty and cannot exceed 10,000 characters (excluding HTML tags and line breaks).
companyIdsstring- Company IDs to link to the note
contactIdsstring- Contact IDs to link to the note. For creation, at least one entity (contact, company, or deal) must be provided.
dealIdsstring- Deal IDs to link to the note
isPinnedstring- Whether to pin or unpin the note. Only applicable when updating a note.
brevomcp_objects_batch_delete_object_recordsUse this endpoint to delete multiple object records of the same object-type in one request.WriteObjects 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**.
Inputs
object_typestringrequired- Object type for the records to delete
identifiersstring- Either `ids` or `ext_ids` must be provided, but not both in the same request.
brevomcp_objects_upsertrecordsThis API allows bulk upsert of object records in a single request.WriteObjects Upsertrecords
This API allows bulk upsert of object records in a single request. Each object record may include attributes, identifiers, and associations.
Inputs
object_typestringrequired- Object 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).
recordsstringrequired- List of object records to be upsert. Each record can have attributes, identifiers, and associations.
brevomcp_payments_create_payment_requestCreate a new payment request for a Brevo contact.WritePayments 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.
Inputs
cartstringrequired- Specify the payment currency and amount.
contactIdintegerrequired- Brevo ID of the contact requested to pay.
referencestringrequired- Reference of the payment request, it will appear on the payment page.
configurationstring- Optional. 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
descriptionstring- Description of payment request.
notificationstring- Optional. 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_products_create_product_alertRegister a contact to receive an alert for a specific product event, such as `back_in_stock`.WriteProducts 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`.
Inputs
idstringrequired- Product ID
typestringrequired- Alert type
contactIdentifiersstring- No description.
brevomcp_products_create_update_batch_productsCreate or update multiple ecommerce products in a single request.WriteProducts 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).
Inputs
productsstringrequired- array of products objects
updateEnabledstring- Facilitate to update the existing products in the same request (updateEnabled = true)
brevomcp_products_create_update_productCreate a new ecommerce product or update an existing one, identified by the mandatory `id` field.WriteProducts 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.
Inputs
idstringrequired- Product ID for which you requested the details
alternativePricestring- Alternative price of the product
brandstring- Brand of the product
categoriesstring- Category ID-s of the product
deletedAtstring- UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted from the shop's database
descriptionstring- Description of the product
imageUrlstring- Absolute URL to the cover image of the product
isDeletedstring- product deleted from the shop's database
metaInfostring- Meta 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.
namestring- Mandatory in case of creation. Name of the product, as displayed in the shop
parentIdstring- Parent product id of the product
pricestring- Price of the product
skustring- Product identifier from the shop
stockstring- Current stock value of the product from the shop's database
updateEnabledstring- Facilitate to update the existing product in the same request (updateEnabled = true)
urlstring- URL to the product
brevomcp_senders_create_senderCreates a new email sender in your Brevo account.WriteSenders Create Sender
Creates a new email sender in your Brevo account. Both `name` and `email` are required fields.
Inputs
emailstringrequired- From email to use for the sender. A verification email will be sent to this address.
namestringrequired- From Name to use for the sender
ipsstring- Mandatory in case of dedicated IP. IPs to associate to the sender. Not required for standard accounts.
brevomcp_senders_update_senderUpdates an existing email sender's configuration.WriteSenders Update Sender
Updates an existing email sender's configuration. At least one field (name, email, or ips) must be provided.
- Idempotent
Inputs
senderIdintegerrequired- Id of the sender
emailstring- From Email to update the sender
ipsstring- Only in case of dedicated IP. IPs to associate to the sender. If passed, will replace all the existing IPs. Not required for standard accounts.
namestring- From Name to update the sender
brevomcp_senders_validate_sender_by_otpValidates a sender using the OTP (One-Time Password) received via email.WriteSenders Validate Sender By Otp
Validates a sender using the OTP (One-Time Password) received via email.
- Idempotent
Inputs
otpintegerrequired- 6 digit OTP received on email
senderIdintegerrequired- Id of the sender
brevomcp_sms_campaigns_create_sms_campaignCreate a new SMS campaign with the required name, sender, and content fields.WriteSms 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.
Inputs
contentstringrequired- Content 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.
namestringrequired- Name of the campaign
senderstringrequired- Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters
organisationPrefixstring- A 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.
recipientsstring- No description.
scheduledAtstring- UTC 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.
unicodeEnabledstring- Format of the message. It indicates whether the content should be treated as unicode or not.
unsubscribeInstructionstring- Instructions 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_request_sms_recipient_exportExport the recipients of a sent SMS campaign as an asynchronous process, filtered by recipient type (e.g.WriteSms 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.
Inputs
campaignIdintegerrequired- id of the campaign
recipientsTypestringrequired- Filter the recipients based on how they interacted with the campaignone of
alldeliveredansweredsoftBounceshardBouncesunsubscribed notifyURLstring- URL 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_nowSend an existing SMS campaign immediately by scheduling it for the current time.WriteSms 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.
Inputs
campaignIdintegerrequired- id of the campaign
brevomcp_sms_campaigns_send_sms_reportSend a PDF report of an SMS campaign to the specified email addresses.WriteSms 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.
Inputs
campaignIdintegerrequired- id of the campaign
emailstringrequired- Custom attributes for the report email.
languagestring- Language of email content for campaign report sending.
brevomcp_sms_campaigns_send_test_smsSend a test SMS to a specified phone number to preview the campaign before sending it to all recipients.WriteSms 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).
Inputs
campaignIdintegerrequired- Id of the SMS campaign
phoneNumberstringrequired- Mobile 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_campaignUpdate an existing SMS campaign's properties such as name, sender, content, recipients, scheduled date, organisation prefix, and unsubscribe instructions.WriteSms 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the SMS campaign
contentstring- Content 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
namestring- Name of the campaign
organisationPrefixstring- A 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.
recipientsstring- No description.
scheduledAtstring- UTC 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.
senderstring- Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters
unicodeEnabledstring- Format of the message. It indicates whether the content should be treated as unicode or not.
unsubscribeInstructionstring- Instructions 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_statusUpdate the status of an SMS campaign, such as suspending, archiving, or replicating it.WriteSms 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the campaign
statusstring- Note:- replicateTemplate status will be available only for template type campaigns.
brevomcp_tasks_patch_crm_tasks_by_idUpdate an existing CRM task's properties such as name, type, due date, status, duration, notes, assignee, reminder, or linked entities.WriteTasks 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.
Inputs
idstringrequired- Task ID
assignToIdstring- To assign a task to a user you can use either the account email or ID.
companiesIdsstring- Companies ids for companies a task is linked to
contactsIdsstring- Contact ids for contacts linked to this task
datestring- Task date/time
dealsIdsstring- Deal ids for deals a task is linked to
donestring- Task marked as done
durationstring- Duration of task in milliseconds [1 minute = 60000 ms]
namestring- Name of task
notesstring- Notes added to a task
reminderstring- Task reminder date/time for a task
taskTypeIdstring- Id for type of task e.g Call / Email / Meeting etc.
brevomcp_tasks_post_crm_tasksCreate a new CRM task with the specified name, type, due date, and optional associations to contacts, companies, or deals.WriteTasks 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.
Inputs
datestringrequired- Task due date and time
namestringrequired- Name of task
taskTypeIdstringrequired- Id for type of task e.g Call / Email / Meeting etc.
assignToIdstring- To assign a task to a user you can use either the account email or ID.
companiesIdsstring- Companies ids for companies a task is linked to
contactsIdsstring- Contact ids for contacts linked to this task
dealsIdsstring- Deal ids for deals a task is linked to
donestring- Task marked as done
durationstring- Duration of task in milliseconds [1 minute = 60000 ms]
notesstring- Notes added to a task
reminderstring- Task reminder date/time for a task
brevomcp_templates_create_smtp_templateCreate a new transactional email template with the specified sender, subject, and content.WriteTemplates 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.
Inputs
senderstringrequired- Sender 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}
subjectstringrequired- Subject of the template
templateNamestringrequired- Name of the template
attachmentUrlstring- Absolute 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'
htmlContentstring- Body of the message (HTML version). The field must have more than 10 characters. REQUIRED if htmlUrl is empty
htmlUrlstring- Url which contents the body of the email message. REQUIRED if htmlContent is empty
isActivestring- Status of template. isActive = true means template is active and isActive = false means template is inactive
replyTostring- Email on which campaign recipients will be able to reply to
tagstring- Tag of the template
toFieldstring- To 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_post_preview_smtp_email_templatesGenerate a fully rendered preview of a transactional email template by resolving dynamic variables.WriteTemplates Post Preview Smtp Email Templates
Generate a fully rendered preview of a transactional email template by resolving dynamic variables.
Inputs
templateIdintegerrequired- Id of the template.
emailstring- Email of the contact.(Required if params not provided)
paramsstring- Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: {"Firstname":"John", "Lastname":"Doe"}
brevomcp_templates_send_test_templateSend a test email of the specified transactional template to one or more recipients.WriteTemplates 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.
Inputs
templateIdintegerrequired- ID of the transactional template to send as a test. Must be a valid positive integer.
emailTostring- List 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_templateUpdate an existing transactional email template by its numeric ID or custom template identifier string.WriteTemplates 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.
- Idempotent
Inputs
templateIdstringrequired- ID of the template. Can be a numeric template ID or a custom template identifier string.
attachmentUrlstring- Absolute 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
htmlContentstring- Required 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)
htmlUrlstring- Required if htmlContent is empty. URL to the body of the email (HTML)
isActivestring- Status of the template. isActive = false means template is inactive, isActive = true means template is active
replyTostring- Email on which campaign recipients will be able to reply to
senderstring- Sender 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}
subjectstring- Subject of the email
tagstring- Tag of the template
templateNamestring- Name of the template
toFieldstring- To 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_domainBlock a new domain to prevent transactional emails from being sent to any recipient at that domain.WriteTransac 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.
Inputs
domainstringrequired- name of the domain to be blocked
brevomcp_transac_templates_delete_hardbouncesDelete hard bounce records from the blocklist, to be used carefully (e.g.WriteTransac 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.
Inputs
contactEmailstring- Target a specific email address
endDatestring- Ending 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
startDatestring- Starting 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_send_async_transactional_smsSend a transactional SMS message asynchronously to a single mobile number.WriteTransac 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.
Inputs
recipientstringrequired- Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'.
senderstringrequired- Name 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.
contentstring- Content 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.
organisationPrefixstring- A 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.
paramsstring- Pass 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.
tagstring- Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.
templateIdstring- Template ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed.
typestring- Type 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.
unicodeEnabledstring- Format of the message. It indicates whether the content should be treated as unicode or not.
webUrlstring- Webhook to call for each event triggered by the message (delivered etc.)
brevomcp_transac_templates_send_transac_emailSend a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`.WriteTransac 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`.
Inputs
attachmentstring- Array 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.
batchIdstring- UUIDv4 identifier for the scheduled batch of transactional emails. If omitted, a valid UUIDv4 batch identifier is automatically generated.
bccstring- Array of BCC recipient objects. Each object contains an email address and an optional name.
ccstring- Array of CC recipient objects. Each object contains an email address and an optional name.
headersstring- Custom 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"}`
htmlContentstring- HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided.
messageVersionsstring- Array 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.
paramsstring- Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.
replyTostring- Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.
scheduledAtstring- UTC 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.
senderstring- Sender 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.
subjectstring- Email subject line. Required when `templateId` is not provided.
tagsstring- Array of tags for categorizing and filtering emails
templateIdstring- Template identifier
textContentstring- Plain text body content of the email. Ignored when `templateId` is provided.
tostring- Array 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_smsSend a transactional SMS message to a single mobile number.WriteTransac 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.
Inputs
recipientstringrequired- Mobile number to send SMS with the country code. Must contain between 6 and 15 digits, optionally prefixed with '+'.
senderstringrequired- Name 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.
contentstring- Content 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.
organisationPrefixstring- A 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.
paramsstring- Pass 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.
tagstring- Tag of the message. Can be a single string or an array of strings (maximum 10 tags). Each tag must be a non-empty string.
templateIdstring- Template ID to send SMS with the template. When provided, overrides the content parameter. Mandatory if 'content' is not passed.
typestring- Type 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.
unicodeEnabledstring- Format of the message. It indicates whether the content should be treated as unicode or not.
webUrlstring- Webhook to call for each event triggered by the message (delivered etc.)
brevomcp_users_edit_user_permissionUpdates the feature-level permissions for an existing user in the organization.WriteUsers Edit User Permission
Updates the feature-level permissions for an existing user in the organization.
Inputs
all_features_accessstringrequired- All access to the features
emailstringrequired- Email address for the organization
privilegesstringrequired- No description.
brevomcp_users_inviteuserInvite a new user to the organization with specified feature permissions.WriteUsers Inviteuser
Invite a new user to the organization with specified feature permissions.
Inputs
all_features_accessstringrequired- All access to the features
emailstringrequired- Email address for the organization
privilegesstringrequired- No description.
brevomcp_users_put_revoke_user_permissionRevokes all permissions for an invited user in the organization, effectively removing their access to the platform.WriteUsers 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.
- Idempotent
Inputs
emailstringrequired- Email of the invited user.
brevomcp_users_putresendcancelinvitationResends or cancels a pending invitation for a user in the organization, depending on the action path parameter.WriteUsers 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.
- Idempotent
Inputs
actionstringrequired- actionone of
resendcancel emailstringrequired- Email of the invited user.
brevomcp_webhooks_management_create_webhookCreates a new webhook to receive real-time notifications for specified events.WriteWebhooks 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).
Inputs
urlstringrequired- URL of the webhook
authstring- Add authentication on webhook url
batchedstring- To send batched webhooks
channelstring- Channel of the webhook
descriptionstring- Description of the webhook
domainstring- Inbound domain of webhook, required in case of event type `inbound`
eventsstring- Events 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`.
headersstring- Custom headers to be send with webhooks
typestring- Type of the webhook
brevomcp_webhooks_management_export_webhooks_historyExports webhook event history to CSV format for analysis and reporting.WriteWebhooks Management Export Webhooks History
Exports webhook event history to CSV format for analysis and reporting.
Inputs
eventstringrequired- Filter the history for a specific event typeone of
invalid_parametermissing_parameterhardBouncesoftBouncedeliveredspamrequestopenedclickinvaliddeferredblockedunsubscribederroruniqueOpenedloadedByProxyallEvents notifyURLstringrequired- Webhook URL to receive CSV file link
typestringrequired- Filter the history based on webhook typeone of
transactionalmarketing daysstring- Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'.
emailstring- Filter the history for a specific email
endDatestring- Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than or equal to startDate.
messageIdstring- Filter the history for a specific message id. Applicable only for transactional webhooks.
sortstring- Sorting order of records (asc or desc)
startDatestring- Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD). Must be lower than or equal to endDate.
webhookIdstring- Filter the history for a specific webhook id
brevomcp_webhooks_management_update_webhookUpdates an existing webhook configuration and event subscriptions.WriteWebhooks 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.
- Idempotent
Inputs
webhookIdintegerrequired- Id of the webhook
authstring- Add authentication on webhook url
batchedstring- To send batched webhooks
descriptionstring- Description of the webhook
domainstring- Inbound domain of webhook, used in case of event type `inbound`
eventsstring- - 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`.
headersstring- Custom headers to be send with webhooks
urlstring- URL of the webhook
brevomcp_whatsapp_campaigns_create_whats_app_campaignCreate a new WhatsApp campaign and schedule it for sending.WriteWhatsapp 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.
Inputs
namestringrequired- Name of the WhatsApp campaign creation
recipientsstringrequired- Segment ids and List ids to include/exclude from campaign
scheduledAtstringrequired- Sending 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
templateIdintegerrequired- Id of the WhatsApp template in approved state
brevomcp_whatsapp_campaigns_send_whats_app_template_approvalSubmit a WhatsApp template for approval by Meta.WriteWhatsapp 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.
Inputs
templateIdintegerrequired- id of the template
brevomcp_whatsapp_campaigns_update_whats_app_campaignUpdate an existing WhatsApp campaign's name, status, recipients, or scheduled sending time.WriteWhatsapp 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the campaign
campaignNamestring- Name of the campaign
campaignStatusstring- Status of the campaign
recipientsstring- Segment ids and List ids to include/exclude from campaign
rescheduleForstring- Reschedule 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_templateCreate a new WhatsApp message template with the specified name, language, category, and body text.WriteWhatsapp 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.
Inputs
bodyTextstringrequired- Body of the template. Maximum allowed characters are 1024
categorystringrequired- Category of the templateone of
MARKETINGUTILITY languagestringrequired- Language of the template. For Example : en for English
namestringrequired- Name of the template
headerTextstring- Text 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
mediaUrlstring- Absolute 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
sourcestring- source of the template
brevomcp_whatsapp_management_send_whatsapp_messageSend a WhatsApp message to one or more contacts.WriteWhatsapp 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.
Inputs
contactNumbersstringrequired- List of phone numbers of the contacts
senderNumberstringrequired- WhatsApp Number with country code. Example, 85264318721
paramsstring- Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}.
templateIdstring- ID of the template to send
textstring- Text to be sent as message body (will be overridden if templateId is passed in the same request)
brevomcp_accounts_delete_corporate_sub_account_by_idPermanently deletes a sub-account from the corporate master account.DestructiveAccounts 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.
- Idempotent
Inputs
idintegerrequired- Id of the sub-account organization to be deleted
brevomcp_accounts_delete_corporate_user_revoke_by_emailRevokes access for an invited admin user on the corporate master account.DestructiveAccounts 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.
- Idempotent
Inputs
emailstringrequired- Email of the invited user
brevomcp_attributes_delete_attributePermanently delete an existing contact attribute by its category and name.DestructiveAttributes 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.
- Idempotent
Inputs
attributeCategorystringrequired- Category of the attributeone of
normaltransactionalcategorycalculatedglobal attributeNamestringrequired- Name of the existing attribute
brevomcp_attributes_delete_crm_attributes_by_idDelete an existing custom attribute by its identifier.DestructiveAttributes 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.
- Idempotent
Inputs
idstringrequired- Attribute ID
brevomcp_attributes_delete_multi_attribute_optionsDelete a specific option from an existing multiple-choice contact attribute.DestructiveAttributes 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.
- Idempotent
Inputs
attributeTypestringrequired- Type of the attribute
multipleChoiceAttributestringrequired- Name of the existing multiple-choice attribute
multipleChoiceAttributeOptionstringrequired- Name of the existing multiple-choice attribute option that you want to delete
brevomcp_companies_delete_by_idPermanently delete a company by its identifier.DestructiveCompanies 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.
- Idempotent
Inputs
idstringrequired- Company ID to delete
brevomcp_contacts_delete_contactPermanently delete a contact identified by their email address, numeric ID, or other identifier.DestructiveContacts 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.
- Idempotent
Inputs
identifierstringrequired- Email (urlencoded) OR ID of the contact OR EXT_ID attribute (urlencoded)
identifierTypestring- email_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_conversations_delete_messages_by_idDelete a message sent by an agent.DestructiveConversations 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.
- Idempotent
Inputs
idstringrequired- ID of the message
brevomcp_conversations_delete_pushed_messages_by_idDelete an automated (pushed) message by its ID.DestructiveConversations 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.
- Idempotent
Inputs
idstringrequired- ID of the message
brevomcp_deals_delete_crm_deals_by_idPermanently delete a deal by its identifier.DestructiveDeals 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.
- Idempotent
Inputs
idstringrequired- No description.
brevomcp_domains_delete_domainDeletes a domain from Brevo.DestructiveDomains Delete Domain
Deletes a domain from Brevo.
- Idempotent
Inputs
domainNamestringrequired- Domain name
brevomcp_email_campaign_management_delete_email_campaignDelete an email campaign by its campaign ID.DestructiveEmail 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the campaign
brevomcp_external_feeds_delete_external_feedDeletes an external feed from your Brevo account.DestructiveExternal Feeds Delete External Feed
Deletes an external feed from your Brevo account.
- Idempotent
Inputs
uuidstringrequired- UUID of the feed to delete
brevomcp_files_delete_crm_files_by_idPermanently delete a CRM file by its identifier.DestructiveFiles 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.
- Idempotent
Inputs
idstringrequired- File id to delete.
brevomcp_folders_delete_folderPermanently delete a folder identified by its ID.DestructiveFolders 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.
- Idempotent
Inputs
folderIdintegerrequired- Id of the folder
brevomcp_groups_delete_corporate_group_by_idDeletes a group of sub-organizations.DestructiveGroups 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.
- Idempotent
Inputs
idstringrequired- Id of the group
brevomcp_lists_delete_listPermanently delete a contact list identified by its ID.DestructiveLists 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.
- Idempotent
Inputs
listIdintegerrequired- Id of the list
brevomcp_loyalty_delete_balance_definitionPermanently deletes a balance definition from a loyalty program.DestructiveLoyalty 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.
- Idempotent
Inputs
bdidstringrequired- Balance Definition Id
pidstringrequired- Loyalty Program Id
brevomcp_loyalty_delete_balance_limitPermanently deletes a balance limit from a balance definition.DestructiveLoyalty Delete Balance Limit
Permanently deletes a balance limit from a balance definition. Once deleted, the limit constraint is no longer enforced on transactions.
- Idempotent
Inputs
bdidstringrequired- Balance Definition Id
blidstringrequired- Balance Limit Id
pidstringrequired- Loyalty Program Id
brevomcp_loyalty_delete_contact_membersRemoves one or more members from a subscription.DestructiveLoyalty 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.
- Idempotent
Inputs
memberContactIdsstringrequired- Comma-separated list of member contact IDs to delete from the subscription.
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
brevomcp_loyalty_delete_contact_subscriptionRemoves a contact's subscription from a loyalty program.DestructiveLoyalty 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.
- Idempotent
Inputs
cidintegerrequired- Contact ID.
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
brevomcp_loyalty_delete_programPermanently deletes a loyalty program and all its associated data.DestructiveLoyalty 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.
- Idempotent
Inputs
pidstringrequired- Loyalty Program ID. A unique identifier for the loyalty program.
brevomcp_loyalty_delete_tierDeletes a tier from a loyalty program.DestructiveLoyalty 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.
- Idempotent
Inputs
pidstringrequired- Loyalty Program ID
tidstringrequired- Tier ID
brevomcp_loyalty_delete_tier_groupDeletes a tier group from a loyalty program.DestructiveLoyalty 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.
- Idempotent
Inputs
gidstringrequired- Tier group ID
pidstringrequired- Loyalty Program ID
brevomcp_loyalty_revoke_vouchersRevokes one or more attributed vouchers by their IDs.DestructiveLoyalty 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.
- Idempotent
Inputs
pidstringrequired- Loyalty Program ID
attributedRewardIdsstring- Reward Attribution IDs (comma seperated)
brevomcp_notes_delete_crm_notes_by_idPermanently delete a CRM note by its identifier.DestructiveNotes 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.
- Idempotent
Inputs
idstringrequired- Note ID to delete
brevomcp_payments_delete_payment_requestDelete a payment request by its UUID.DestructivePayments 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.
- Idempotent
Inputs
idstringrequired- ID of the payment request.
brevomcp_senders_delete_senderDeletes an email sender from your Brevo account.DestructiveSenders Delete Sender
Deletes an email sender from your Brevo account. The sender ID must be a valid positive integer.
- Idempotent
Inputs
senderIdintegerrequired- Id of the sender
brevomcp_sms_campaigns_delete_sms_campaignDelete an SMS campaign by its campaign ID.DestructiveSms 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the SMS campaign
brevomcp_tasks_delete_crm_tasks_by_idPermanently delete a CRM task by its identifier.DestructiveTasks 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.
- Idempotent
Inputs
idstringrequired- Task ID
brevomcp_templates_delete_smtp_templatePermanently delete a transactional email template by its numeric ID.DestructiveTemplates 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`.
- Idempotent
Inputs
templateIdintegerrequired- id of the template
brevomcp_transac_templates_delete_blocked_domainRemove a domain from the blocked domains list, allowing transactional emails to be sent to recipients at that domain again.DestructiveTransac 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`).
- Idempotent
Inputs
domainstringrequired- The name of the domain to be deleted
brevomcp_transac_templates_delete_scheduled_email_by_idDelete scheduled transactional emails, either a batch by its UUIDv4 `batchId` or a single email by its `messageId` (enclosed in angle brackets with an @ sign).DestructiveTransac 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.
- Idempotent
Inputs
identifierstringrequired- The `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_emailUnblock or resubscribe a transactional contact by removing their email address from the blocklist.DestructiveTransac 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.
- Idempotent
Inputs
emailstringrequired- Email address (URL-encoded) of the contact to unblock. Must be a valid email format.
brevomcp_transac_templates_delete_smtp_log_by_identifierDelete SMTP transactional log entries by message ID or email address.DestructiveTransac Templates Delete Smtp Log By Identifier
Delete SMTP transactional log entries by message ID or email address.
- Idempotent
Inputs
identifierstringrequired- Message 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_datestring- Starting date (YYYY-MM-DD format) to narrow down logs for deletion
to_datestring- Ending date (YYYY-MM-DD format) to narrow down logs for deletion
brevomcp_webhooks_management_delete_webhookPermanently deletes a webhook and stops all event notifications.DestructiveWebhooks Management Delete Webhook
Permanently deletes a webhook and stops all event notifications.
- Idempotent
Inputs
webhookIdintegerrequired- Id of the webhook
brevomcp_whatsapp_campaigns_delete_whats_app_campaignDelete a WhatsApp campaign by its campaign ID.DestructiveWhatsapp 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.
- Idempotent
Inputs
campaignIdintegerrequired- id of the campaign
No tools match.