> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Brevo

> Brevo (formerly Sendinblue) is an all-in-one email and SMS marketing platform that provides transactional messaging, marketing automation, contact management, and CRM tools to help businesses communicate and engage with their customers.

![Brevo logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/brevo.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=c68839f38f6289287432b309ff7e0c0c)

* **Category:** email newsletters
* **Auth:** API\_KEY, OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 61
* **Triggers:** 0
* **Slug:** `BREVO`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Contacts to List
>
> **Slug:** `BREVO_ADD_CONTACTS_TO_LIST`
>
> Add existing Brevo contacts to one list using one identifier family.
>
> #### Input Parameters
>
> **emails** `array`
>
> Contact email addresses to add. Supply exactly one of emails, contact\_ids, or external\_ids.
>
> **list\_id** `integer` *required*
>
> ID of the existing Brevo list to which the contacts will be added.
>
> **contact\_ids** `array`
>
> Brevo contact IDs to add. Supply exactly one of emails, contact\_ids, or external\_ids.
>
> **external\_ids** `array`
>
> Caller-owned external contact IDs to add. Supply exactly one of emails, contact\_ids, or external\_ids.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create a company
>
> **Slug:** `BREVO_CREATE_A_COMPANY`
>
> Creates a new company record in your Brevo CRM. Companies can be used to organize contacts and deals, track business relationships, and manage customer accounts. You can add custom attributes, link existing contacts and deals, and set country codes for international phone numbers. Use this when you need to add a new business or organization to your CRM system.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the company to be created. This is the primary identifier for the company.
>
> **attributes** `object`
>
> Custom attributes for the company. Common attributes include 'domain' (company website), 'industry' (business sector), 'owner' (user ID who owns this company record), 'phone\_number', 'address', 'city', 'country', 'zip\_code', etc. Attribute names and types depend on your Brevo account configuration.
>
> **countryCode** `integer`
>
> Country code for phone numbers included in attributes (e.g., 1 for USA, 91 for India, 44 for UK). Required only when phone number attributes are provided.
>
> **linkedDealsIds** `array`
>
> List of deal IDs to associate with this company. Use this to link existing deals to the newly created company.
>
> **linkedContactsIds** `array`
>
> List of contact IDs to associate with this company. Use this to link existing contacts to the newly created company.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact
>
> **Slug:** `BREVO_CREATE_CONTACT`
>
> Create a Brevo contact, or update a matching contact when explicitly enabled.
>
> #### Input Parameters
>
> **email** `string`
>
> Contact email address. Required unless ext\_id or attributes.SMS is provided.
>
> **ext\_id** `string`
>
> Caller-owned external identifier. Required unless email or attributes.SMS is provided.
>
> **get\_id** `boolean`
>
> When true, ask Brevo to return the surviving contact ID after a forced merge.
>
> **list\_ids** `array`
>
> Brevo list IDs to which the contact should be added.
>
> **attributes** `object`
>
> Existing Brevo contact attributes and values. Attribute names must be uppercase and already exist in the account; mismatched value types are silently ignored. Use SMS with a country-coded number to identify a contact without email or ext\_id.
>
> **force\_merge** `boolean`
>
> Destructive operation. When true and identifiers conflict, Brevo merges the contacts, keeps the most recently modified contact, and permanently deletes the other. Brevo defaults this to false and otherwise returns an error on conflict.
>
> **update\_enabled** `boolean`
>
> When true, update a matching existing contact instead of failing on conflict. Brevo defaults this to false; an existing-contact update succeeds with HTTP 204 and returns no contact ID.
>
> **sms\_blacklisted** `boolean`
>
> Whether to block the contact from receiving SMS campaigns.
>
> **email\_blacklisted** `boolean`
>
> Whether to block the contact from receiving email campaigns.
>
> **smtp\_blacklist\_sender** `array`
>
> Transactional sender email addresses forbidden for this email contact. Brevo supports this only when update\_enabled is true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact Attribute
>
> **Slug:** `BREVO_CREATE_CONTACT_ATTRIBUTE`
>
> Create a Brevo contact attribute definition.
>
> #### Input Parameters
>
> **type** `string ("text" | "date" | "float" | "boolean" | "id" | "category" | "multiple-choice" | "user")`
>
> Attribute data type. Required for normal, transactional, and category attributes.
>
> **value** `string`
>
> Formula or value required for calculated and global attributes.
>
> **enumeration** `array`
>
> Values available to a category attribute.
>
> **is\_recurring** `boolean`
>
> Whether a calculated or global attribute recurs.
>
> **attribute\_name** `string` *required*
>
> Name of the new contact attribute.
>
> **attribute\_category** `string ("normal" | "transactional" | "category" | "calculated" | "global")` *required*
>
> Brevo category in which to create the contact attribute.
>
> **multi\_category\_options** `array`
>
> Choices for a normal multiple-choice attribute, each up to 200 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact List
>
> **Slug:** `BREVO_CREATE_CONTACT_LIST`
>
> Creates a new contact list (audience) in Brevo within a specified folder. Contact lists are used to organize and segment contacts for email campaigns, SMS campaigns, and marketing automation workflows. Use this tool when you need to: - Create a new audience segment for a marketing campaign - Organize contacts by specific criteria (e.g., geographic location, interests, purchase history) - Set up a list for newsletter subscribers, event attendees, or customer segments - Prepare a target audience before adding contacts or launching campaigns Note: You must specify a valid folder ID. Use Get Contact Lists to view existing folders and their IDs.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the contact list to be created. Must be unique within the folder. Use descriptive names that indicate the list's purpose (e.g., 'Newsletter Subscribers', 'VIP Customers', 'Product Launch Campaign').
>
> **folderId** `integer` *required*
>
> ID of the parent folder in which this list is to be created. Use the Get Contact Lists or Get Folders endpoint to retrieve valid folder IDs from your Brevo account. Folder IDs are integers (e.g., 1, 2, 3).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Deal
>
> **Slug:** `BREVO_CREATE_DEAL`
>
> Create a Brevo CRM deal with optional attributes and associations.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the deal.
>
> **attributes** `object`
>
> Deal attribute values. Use deal\_owner for an owner email or ID, and pipeline and deal\_stage for their corresponding CRM IDs.
>
> **linked\_contacts\_ids** `array`
>
> Brevo contact IDs to associate with the new deal.
>
> **linked\_companies\_ids** `array`
>
> Brevo company IDs to associate with the new deal.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Email Campaign
>
> **Slug:** `BREVO_CREATE_EMAIL_CAMPAIGN`
>
> Create an email campaign as a draft, or schedule it when requested.
>
> #### Input Parameters
>
> **tag** `string`
>
> Tag used to categorize the campaign.
>
> **name** `string` *required*
>
> Name of the email campaign.
>
> **footer** `string`
>
> Email campaign footer.
>
> **header** `string`
>
> Email campaign header.
>
> **params** `object`
>
> Template attributes used to personalize a classic campaign in New Template Language format.
>
> **sender** `object` *required*
>
> Sender selected by exactly one email address or sender ID.
>
> **subject** `string`
>
> Campaign subject. Required unless ab\_testing is true; ignored by Brevo for A/B campaigns.
>
> **html\_url** `string`
>
> Public URL from which Brevo retrieves the HTML content. Provide exactly one of html\_content, html\_url, or template\_id.
>
> **reply\_to** `string`
>
> Email address to which recipient replies are sent.
>
> **to\_field** `string`
>
> Personalization expression for the recipient name in the To field; referenced contact attributes must already exist.
>
> **utm\_term** `string`
>
> Custom utm\_term value for tracked links; Brevo documents alphanumeric characters and spaces.
>
> **subject\_a** `string`
>
> Subject for A/B variant A. Required when ab\_testing is true and must differ from subject\_b.
>
> **subject\_b** `string`
>
> Subject for A/B variant B. Required when ab\_testing is true and must differ from subject\_a.
>
> **ab\_testing** `boolean`
>
> Enable subject-line A/B testing. This premium feature can return 405 when the account plan does not support it and cannot be combined with send\_at\_best\_time.
>
> **recipients** `object`
>
> Included and excluded contact lists or segments. Required with a non-empty inclusion list or segment when scheduled\_at is supplied.
>
> **split\_rule** `integer`
>
> A/B test-group size from 1 through 50. Required for A/B testing when recipients are supplied.
>
> **template\_id** `integer`
>
> ID of an active transactional template whose content is copied into the campaign. Provide exactly one of template\_id, html\_content, or html\_url.
>
> **utm\_content** `string`
>
> Custom utm\_content value for tracked links; Brevo documents alphanumeric characters and spaces.
>
> **html\_content** `string`
>
> Inline HTML content, longer than 10 characters and smaller than 1 MB. Provide exactly one of html\_content, html\_url, or template\_id.
>
> **preview\_text** `string`
>
> Email preview text or preheader.
>
> **scheduled\_at** `string`
>
> Date-time at which Brevo should schedule sending. Include UTC or a timezone offset. Omit this field to create a draft without sending or scheduling it.
>
> **utm\_campaign** `string`
>
> Custom utm\_campaign value for tracked links; Brevo documents alphanumeric characters and spaces.
>
> **winner\_delay** `integer`
>
> Hours before selecting the A/B winner, from 1 through 168. Required when split\_rule is 1 through 49 and ignored when it is 50.
>
> **increase\_rate** `integer`
>
> Daily IP-warmup quota increase percentage from 0 through 100; required when ip\_warmup\_enable is true.
>
> **initial\_quota** `integer`
>
> Initial daily quota for IP warmup; must be greater than 1 when ip\_warmup\_enable is true.
>
> **mirror\_active** `boolean`
>
> Whether to include a browser mirror link.
>
> **attachment\_url** `string`
>
> Absolute URL of an attachment in a Brevo-supported document, image, archive, calendar, or presentation format; local files are not accepted.
>
> **update\_form\_id** `string`
>
> 24-character alphanumeric update-profile form ID. Required when the selected template contains the \{\{ update\_profile }} tag unless its default form is appropriate.
>
> **winner\_criteria** `string ("open" | "click")`
>
> Metric used to choose the winning A/B variant. Required when split\_rule is 1 through 49 and ignored when it is 50.
>
> **ip\_warmup\_enable** `boolean`
>
> Enable IP warmup. This is available only to dedicated-IP accounts and requires initial\_quota and increase\_rate.
>
> **send\_at\_best\_time** `boolean`
>
> Let Brevo choose each recipient's best sending time. This premium feature can return 405 when unsupported, cannot be combined with A/B testing, and uses only the date portion of scheduled\_at.
>
> **email\_expiration\_date** `object`
>
> Optional expiration duration after which supporting email clients may delete the message.
>
> **unsubscription\_page\_id** `string`
>
> 24-character alphanumeric Brevo unsubscription-page ID. Omit it to use the default page.
>
> **inline\_image\_activation** `boolean`
>
> Embed images in the email. The resulting message must remain below 4 MB and cannot be sent to more than 5,000 contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create or Update Email Template
>
> **Slug:** `BREVO_CREATE_OR_UPDATE_EMAIL_TEMPLATE`
>
> This tool creates a new email template or updates an existing one in Brevo. If a 'templateId' is provided, it performs an update; otherwise, it creates a new template.
>
> #### Input Parameters
>
> **tag** `string`
>
> A tag to categorize the template.
>
> **sender** `object`
>
> Sender information. Required when creating a new template.
>
> **htmlUrl** `string`
>
> A URL to the HTML content of the email template. Use this or htmlContent, not both.
>
> **replyTo** `string`
>
> The email address for replies.
>
> **subject** `string`
>
> Subject line of the email. Required when creating a new template.
>
> **toField** `string`
>
> Personalization for the recipient's display name in the 'To' field. Use \{FNAME} \{LNAME} or \{\{contact.FNAME}} \{\{contact.LNAME}} syntax.
>
> **isActive** `boolean`
>
> Set to true to activate the template, false to deactivate.
>
> **templateId** `integer`
>
> ID of the template to update. If not provided, a new template will be created.
>
> **htmlContent** `string`
>
> The HTML content of the email template (minimum 10 characters). Use this or htmlUrl, not both. Supports personalization with \{\{contact.ATTRIBUTE}} syntax.
>
> **templateName** `string`
>
> Name of the email template. Required when creating a new template.
>
> **attachmentUrl** `string`
>
> Absolute URL of a file to attach to the email. Supports: xlsx, xls, ods, docx, doc, csv, pdf, txt, gif, jpg, jpeg, png, zip, and more.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Sender
>
> **Slug:** `BREVO_CREATE_SENDER`
>
> Create a Brevo email sender identity and return DNS configuration warnings.
>
> #### Input Parameters
>
> **ips** `array`
>
> Dedicated IP assignments. Required for dedicated-IP accounts; omit this field for a standard account.
>
> **name** `string` *required*
>
> Display name for the sender identity.
>
> **email** `string` *required*
>
> Email address for the sender identity. Brevo may send a verification email to this address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Sender Domain
>
> **Slug:** `BREVO_CREATE_SENDER_DOMAIN`
>
> Register a Brevo sender domain and return available DNS authentication records.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Domain or subdomain to register with Brevo.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create SMS Campaign
>
> **Slug:** `BREVO_CREATE_SMS_CAMPAIGN`
>
> This tool allows you to create a new SMS campaign in Brevo. You can specify the campaign name, sender, content, recipients (by providing list IDs, exclusion list IDs, or segment IDs), and optionally schedule the campaign for a specific time. You can also enable Unicode characters, add an organization prefix, and include unsubscribe instructions.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the campaign.
>
> **sender** `string` *required*
>
> Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters.
>
> **content** `string` *required*
>
> 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.
>
> **recipients** `object`
>
> Recipients of the campaign. You can provide list IDs, exclusion list IDs, or segment IDs. Dict keys: `listIds` (array of list IDs to target), `exclusionListIds` (array of list IDs to exclude), `segmentIds` (array of segment IDs to target).
>
> **scheduledAt** `string`
>
> 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.
>
> **unicodeEnabled** `boolean`
>
> Format of the message. It indicates whether the content should be treated as unicode or not. Defaults to false.
>
> **organisationPrefix** `string`
>
> 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.
>
> **unsubscribeInstruction** `string`
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete a company
>
> **Slug:** `BREVO_DELETE_COMPANY`
>
> Deletes a company from Brevo using its unique identifier.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the company to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `BREVO_DELETE_CONTACT`
>
> Deletes a contact from Brevo by email, contact ID, external ID, phone number, WhatsApp ID, or landline number. Use the identifier\_type parameter to specify the type of identifier when using ext\_id, phone\_id, whatsapp\_id, or landline\_number\_id.
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> Identifier of the contact to delete. Can be: email address, contact ID (integer), ext\_id, phone number (with country code), WhatsApp ID, or landline number.
>
> **identifier\_type** `string ("email_id" | "contact_id" | "ext_id" | "phone_id" | "whatsapp_id" | "landline_number_id")`
>
> Type of identifier being used. If not specified, Brevo will auto-detect based on format (works for email and contact ID). For other types (ext\_id, phone\_id, whatsapp\_id, landline\_number\_id), this parameter should be explicitly specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact List
>
> **Slug:** `BREVO_DELETE_CONTACT_LIST`
>
> Permanently delete a Brevo contact list without deleting its contacts.
>
> #### Input Parameters
>
> **list\_id** `integer` *required*
>
> Positive numeric ID of the contact list to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email Campaign
>
> **Slug:** `BREVO_DELETE_EMAIL_CAMPAIGN`
>
> Delete an unscheduled campaign and related template, builder, and schedule data.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Positive integer ID of the unscheduled email campaign to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email Template
>
> **Slug:** `BREVO_DELETE_EMAIL_TEMPLATE`
>
> This tool deletes an inactive email template from Brevo. You need to provide the 'templateId' of the email template you want to delete. Only inactive templates can be deleted.
>
> #### Input Parameters
>
> **template\_id** `integer` *required*
>
> ID of the template to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete SMS Campaign
>
> **Slug:** `BREVO_DELETE_SMS_CAMPAIGN`
>
> This tool deletes an existing SMS campaign.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> ID of the SMS campaign to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Email Campaign Recipients
>
> **Slug:** `BREVO_EXPORT_EMAIL_CAMPAIGN_RECIPIENTS`
>
> Start an asynchronous CSV export of a sent email campaign's recipients.
>
> #### Input Parameters
>
> **notify\_url** `string`
>
> HTTP or HTTPS webhook URL Brevo calls when the asynchronous export finishes.
>
> **campaign\_id** `integer` *required*
>
> Positive integer ID of the sent email campaign whose recipients should be exported.
>
> **recipients\_type** `string ("all" | "nonClickers" | "nonOpeners" | "clickers" | "openers" | "softBounces" | "hardBounces" | "unsubscribed")` *required*
>
> Recipient class to include in the CSV export.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Information
>
> **Slug:** `BREVO_GET_ACCOUNT_INFO`
>
> Retrieves comprehensive information about the authenticated Brevo account. Returns account details including: - Account holder information (email, first name, last name, company name) - Complete address (street, city, zip code, country) - Plan details with credit information (type, credits remaining, start/end dates) - Relay configuration for transactional emails (enabled status and data) - Marketing Automation status and tracker key (if enabled) No input parameters are required - the action uses the authenticated account's credentials. Use this action to: - Verify account configuration and settings - Check available credits and plan type - Monitor transactional email relay status - Retrieve Marketing Automation tracker information. If credentials are missing or invalid, verify the Brevo connection is active before calling — retries will not resolve credential issues. If blocked by an 'unrecognised IP address' error, add the integration host's IP to the Brevo account allowlist.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Aggregated Transactional Email Report
>
> **Slug:** `BREVO_GET_AGGREGATED_TRANSACTIONAL_EMAIL_REPORT`
>
> Return aggregate delivery and engagement totals for transactional emails.
>
> #### Input Parameters
>
> **tag** `string`
>
> Return aggregate statistics only for transactional emails with this tag.
>
> **days** `integer`
>
> Number of past days to include, including today (1-90). Cannot be combined with start\_date or end\_date; Brevo defaults to 90 days when no date selector is provided.
>
> **end\_date** `string`
>
> End of an explicit report range in YYYY-MM-DD format. Must be provided with start\_date, be on or after it, and be no more than 90 days later.
>
> **start\_date** `string`
>
> Start of an explicit report range in YYYY-MM-DD format. Must be provided with end\_date and cannot be combined with days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all contacts
>
> **Slug:** `BREVO_GET_ALL_CONTACTS`
>
> Retrieves a page of Brevo contacts, with filters for creation or modification dates, list IDs, or a segment ID. For complete retrieval, increment the offset by the limit on each call until no more records are returned.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort the results in the ascending/descending order of record creation.
>
> **limit** `integer`
>
> Number of documents per page
>
> **offset** `integer`
>
> Index of the first document of the page
>
> **listIds** `array`
>
> List of list IDs to filter contacts. Cannot be used together with segment\_id.
>
> **segmentId** `integer`
>
> ID of the segment to filter contacts. Cannot be used together with list\_ids.
>
> **createdSince** `string`
>
> Filter contacts created after a given UTC date-time. Format: YYYY-MM-DDTHH:mm:ss.SSSZ or YYYY-MM-DDTHH:mm:ss+HH:MM
>
> **modifiedSince** `string`
>
> Filter contacts modified after a given UTC date-time. Format: YYYY-MM-DDTHH:mm:ss.SSSZ or YYYY-MM-DDTHH:mm:ss+HH:MM
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all email templates
>
> **Slug:** `BREVO_GET_ALL_EMAIL_TEMPLATES`
>
> This tool retrieves a list of all email templates created in your Brevo account. It corresponds to the GET /v3/smtp/templates endpoint as per the Brevo API documentation, with optional parameters for filtering (templateStatus), pagination (limit, offset), and sorting (asc/desc).
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed
>
> **limit** `integer`
>
> Number of email templates to return per page (default: 50, max: 1000)
>
> **offset** `integer`
>
> Index of the first template to return (default: 0, use for pagination)
>
> **templateStatus** `boolean`
>
> Filter on the status of the template. Active = true, inactive = false
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get All Senders
>
> **Slug:** `BREVO_GET_ALL_SENDERS`
>
> This tool retrieves a list of all senders associated with the Brevo account. Senders are the email addresses or domains that are authorized to send emails through Brevo. This action can be useful for managing and verifying sender identities.
>
> #### Input Parameters
>
> **ip** `string`
>
> Filter senders for a specific ip. Available for dedicated IP usage only
>
> **domain** `string`
>
> Filter senders for a specific domain
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Company Details
>
> **Slug:** `BREVO_GET_COMPANY_DETAILS`
>
> Retrieves detailed information about a specific company from Brevo's CRM. Returns company data including its unique identifier, custom attributes, and lists of linked contact IDs and deal IDs. This is useful for accessing comprehensive company records and understanding company relationships.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> ID of the company to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact Campaign Stats
>
> **Slug:** `BREVO_GET_CONTACT_CAMPAIGN_STATS`
>
> Retrieve a contact's email campaign statistics for a bounded date range.
>
> #### Input Parameters
>
> **end\_date** `string`
>
> End of the campaign statistics range in YYYY-MM-DD format. Must be provided with start\_date, cannot be in the future, and may be at most 90 days after start\_date.
>
> **identifier** `string` *required*
>
> Email address or numeric ID of the contact. The value is safely URL-encoded before it is sent to Brevo.
>
> **start\_date** `string`
>
> Start of the campaign statistics range in YYYY-MM-DD format. Must be provided with end\_date, cannot be in the future, and defaults with end\_date to Brevo's recent 90-day window when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact Details
>
> **Slug:** `BREVO_GET_CONTACT_DETAILS`
>
> This tool retrieves detailed information about a specific contact in Brevo. You can identify the contact using their email address (URL-encoded), their unique contact ID, or their SMS attribute value.
>
> #### Input Parameters
>
> **identifier** `string`
>
> Email address (raw or URL-encoded), numeric contact ID, or SMS attribute value. Brevo infers these three identifier types. This action does not support explicit identifierType selection for external IDs, WhatsApp, or landline values.
>
> **mobile\_number** `string`
>
> Mobile phone number (SMS attribute) of the contact to search for. Used as a fallback if the primary identifier is not found. Accepted formats: 91xxxxxxxxxx, +91xxxxxxxxxx, 0091xxxxxxxxxx, or international format like +16135551234.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact List
>
> **Slug:** `BREVO_GET_CONTACT_LIST`
>
> Get contact-list metadata and optional campaign statistics by list ID.
>
> #### Input Parameters
>
> **list\_id** `integer` *required*
>
> Positive numeric ID of the contact list.
>
> **end\_date** `string`
>
> End of the campaign-statistics range as an ISO 8601 date or date-time. Must be provided with start\_date and not precede it.
>
> **start\_date** `string`
>
> Start of the campaign-statistics range as an ISO 8601 date or date-time. Must be provided with end\_date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contact lists
>
> **Slug:** `BREVO_GET_CONTACT_LISTS`
>
> Retrieve one page of Brevo contact lists, including list IDs and names and, when returned, subscriber counts and folder associations. Use pagination to discover further lists.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort order by creation date: 'asc' (oldest first) or 'desc' (newest first).
>
> **limit** `integer`
>
> Number of contact lists to return per page.
>
> **offset** `integer`
>
> Index of the first contact list to return (for pagination).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Campaign Details
>
> **Slug:** `BREVO_GET_EMAIL_CAMPAIGN_DETAILS`
>
> Retrieve details for a specific email campaign, including available HTML content, recipients, and statistics. Statistics can be filtered by type.
>
> #### Input Parameters
>
> **statistics** `string ("globalStats" | "linksStats" | "statsByDomain" | "statsByDevice" | "statsByBrowser")`
>
> Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in returned response.
>
> **campaign\_id** `integer` *required*
>
> Id of the email campaign to retrieve details for.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Template
>
> **Slug:** `BREVO_GET_EMAIL_TEMPLATE`
>
> Retrieve one transactional email template by numeric or custom ID.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> Numeric template ID or custom template identifier. Custom identifiers must start with a letter, contain only letters, numbers, hyphens, or underscores, and be at most 64 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Process
>
> **Slug:** `BREVO_GET_PROCESS`
>
> Retrieve the status and available result details of a Brevo process.
>
> #### Input Parameters
>
> **process\_id** `integer` *required*
>
> Positive numeric ID of the background process to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Campaign Details
>
> **Slug:** `BREVO_GET_SMS_CAMPAIGN_DETAILS`
>
> Retrieves the details of a specific SMS campaign. This action fetches complete information about an SMS campaign including its status, content, sender, scheduling, recipients, and statistics.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> The unique identifier of the SMS campaign to retrieve details for. You can obtain campaign IDs using the 'Get SMS Campaigns' action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Campaigns
>
> **Slug:** `BREVO_GET_SMS_CAMPAIGNS`
>
> List a page of Brevo SMS campaigns, with optional status and sent-date filtering, pagination, and creation-date sorting. Returns campaign overview details including status, content, sender, and dates.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort the results in ascending or descending order of record creation.
>
> **limit** `integer`
>
> Number of results to return.
>
> **offset** `integer`
>
> Beginning point in the list to retrieve from.
>
> **status** `string ("sent" | "draft" | "queued" | "suspended" | "inProcess" | "archive")`
>
> Filter campaigns by their status.
>
> **endDate** `string`
>
> Ending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter sent SMS campaigns. Mandatory if startDate is used.
>
> **startDate** `string`
>
> Starting UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter sent SMS campaigns. Mandatory if endDate is used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Transactional Email
>
> **Slug:** `BREVO_GET_TRANSACTIONAL_EMAIL`
>
> Retrieve a sent transactional email by its identifier, including event history and personalized content when retained by Brevo.
>
> #### Input Parameters
>
> **uuid** `string` *required*
>
> Unique identifier of the sent transactional email to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Contacts
>
> **Slug:** `BREVO_IMPORT_CONTACTS`
>
> Submit a contact import to Brevo and return its background process ID. A 202 response means Brevo accepted the import for asynchronous processing; it does not mean the contacts have finished importing. If notify\_url is supplied, Brevo calls it when processing finishes.
>
> #### Input Parameters
>
> **file\_url** `string`
>
> Public HTTP or HTTPS URL of a .txt, .csv, or .json import file. Local file paths are not supported.
>
> **list\_ids** `array`
>
> IDs of existing contact lists into which the contacts will be imported. Supply this or new\_list, but not both.
>
> **new\_list** `object`
>
> New destination list to create. Both list\_name and folder\_id are required. Supply this or list\_ids, but not both.
>
> **file\_body** `string`
>
> CSV content to import. Use semicolons to separate attributes. Maximum size is 10 MB; around 8 MB is recommended, and file\_url should be used for larger imports.
>
> **json\_body** `array`
>
> Contact rows to import as JSON. Maximum serialized size is 10 MB; around 8 MB is recommended, and file\_url should be used for larger imports.
>
> **notify\_url** `string`
>
> HTTP or HTTPS URL Brevo will call after the asynchronous import process finishes.
>
> **sms\_blacklist** `boolean`
>
> Whether to blacklist every imported contact for SMS. Defaults to false.
>
> **email\_blacklist** `boolean`
>
> Whether to blacklist every imported contact for email. Defaults to false.
>
> **consent\_group\_ids** `array`
>
> IDs of consent groups to which all imported contacts will be added. This option requires consent groups to be enabled for the organization.
>
> **disable\_notification** `boolean`
>
> Whether to disable the import email notification. Defaults to false.
>
> **update\_existing\_contacts** `boolean`
>
> Whether existing contacts should be updated by the import. Defaults to true.
>
> **empty\_contacts\_attributes** `boolean`
>
> Whether empty imported fields erase existing contact attributes. This is effective only when update\_existing\_contacts is true and defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Companies
>
> **Slug:** `BREVO_LIST_ALL_COMPANIES`
>
> This action retrieves a list of all companies stored in the Brevo CRM. It supports pagination and filtering by name and other attributes.
>
> #### Input Parameters
>
> **page** `integer`
>
> Index of the page to retrieve. Starts at 0 or 1 depending on API (Brevo typically 1 for page, 0 for offset). API docs say 'Index of the first document of the page', usually means 0-indexed if 'limit' is also present, or 1-indexed if it's page number. Let's assume 0-indexed for 'page' as it's common with 'limit'. The example shows page=1, so it might be 1-indexed. For safety, let's assume it's flexible and the user provides the correct index based on their understanding or API docs.
>
> **sort** `string ("asc" | "desc")`
>
> Sort the results in ascending or descending order. Default is descending by creation date if not specified.
>
> **limit** `integer`
>
> Number of documents per page. Default is 50, maximum is 100.
>
> **sortBy** `string`
>
> The field used to sort the results (e.g., 'createdAt', 'name', 'attributes.name'). Default is 'createdAt' if sort is specified.
>
> **filters** `string`
>
> Filter by attributes. Example: '''\{"attributes.name":"Company A"}'''. Refer to Brevo API documentation for more complex filtering options.
>
> **linkedDealsIds** `array`
>
> Filter by linked deal IDs. Pass a list of deal IDs.
>
> **linkedContactsIds** `array`
>
> Filter by linked contact IDs. Pass a list of contact IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Attributes
>
> **Slug:** `BREVO_LIST_CONTACT_ATTRIBUTES`
>
> List the contact attributes configured in the Brevo account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Folders
>
> **Slug:** `BREVO_LIST_CONTACT_FOLDERS`
>
> List folders that organize contact lists in the connected Brevo account.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort folders by creation date in ascending or descending order.
>
> **limit** `integer`
>
> Number of contact folders to return in this page (1-50).
>
> **offset** `integer`
>
> Zero-based index of the first contact folder to return. Increase by limit for the next page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Lists in Folder
>
> **Slug:** `BREVO_LIST_CONTACT_LISTS_IN_FOLDER`
>
> List one bounded page of contact lists belonging to a Brevo folder.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort contact lists by creation time in ascending or descending order.
>
> **limit** `integer`
>
> Number of contact lists to return in this page (0-50).
>
> **offset** `integer`
>
> Zero-based index of the first contact list to return.
>
> **folder\_id** `integer` *required*
>
> Positive integer ID of the Brevo folder whose lists should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Segments
>
> **Slug:** `BREVO_LIST_CONTACT_SEGMENTS`
>
> List one page of contact segments configured in the Brevo account.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort order by creation date: ascending or descending.
>
> **limit** `integer`
>
> Maximum number of contact segments to return (1-50).
>
> **offset** `integer`
>
> Zero-based index of the first contact segment to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Notes
>
> **Slug:** `BREVO_LIST_CRM_NOTES`
>
> List one page of Brevo CRM notes, optionally filtered by entity and date.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Creation-time sort order. If omitted, Brevo uses descending order.
>
> **limit** `integer`
>
> Number of notes to request. Brevo defaults to 50 and documents no minimum or maximum for this endpoint.
>
> **entity** `string ("companies" | "deals" | "contacts")`
>
> Entity type whose CRM notes should be returned.
>
> **offset** `integer`
>
> Zero-based index of the first note to return. Pass next\_offset from the previous response to continue.
>
> **date\_to** `integer`
>
> Return notes in the date range ending at this Unix timestamp in milliseconds.
>
> **date\_from** `integer`
>
> Return notes in the date range starting at this Unix timestamp in milliseconds.
>
> **entity\_ids** `string`
>
> Brevo entity ID filter as a single string. Use the serialization expected by Brevo; this is not a list field.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List CRM Pipelines
>
> **Slug:** `BREVO_LIST_CRM_PIPELINES`
>
> List every Brevo CRM deal pipeline with its stages and stage settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Object Records
>
> **Slug:** `BREVO_LIST_CUSTOM_OBJECT_RECORDS`
>
> List one page of records for an Enterprise-only Brevo custom object.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Record sort order. Brevo defaults to descending order.
>
> **limit** `integer`
>
> Number of records to return per page (0-1000). Use 0 to retrieve only the total count; use a positive value for paginated records.
>
> **page\_num** `integer`
>
> One-based page number to retrieve. Pass next\_page from the previous response to continue.
>
> **association** `boolean`
>
> Whether to include associated records. Brevo returns at most five records per association when enabled.
>
> **object\_type** `string` *required*
>
> Previously created Brevo custom object type whose records should be returned. The standard contact object is not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Deals
>
> **Slug:** `BREVO_LIST_DEALS`
>
> List one page of Brevo CRM deals with optional relationship filters.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Creation-time sort order. If omitted, Brevo uses descending order.
>
> **limit** `integer`
>
> Number of deals to return on this page. Brevo defaults to 50.
>
> **offset** `integer`
>
> Zero-based index of the first deal to return.
>
> **sort\_by** `string`
>
> Deal field name used to sort the results.
>
> **pipeline** `string`
>
> Pipeline ID used to filter the results.
>
> **deal\_name** `string`
>
> Deal name used to filter the results.
>
> **deal\_owner** `string`
>
> Deal owner email address used to filter the results.
>
> **deal\_stage** `string`
>
> Deal stage ID used to filter the results.
>
> **created\_since** `string`
>
> UTC date-time after which returned deals were created.
>
> **modified\_since** `string`
>
> UTC date-time after which returned deals were modified.
>
> **linked\_company\_ids** `string`
>
> Provider-formatted linked company ID string used to filter the results.
>
> **linked\_contact\_ids** `string`
>
> Provider-formatted linked contact ID string used to filter the results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Campaigns
>
> **Slug:** `BREVO_LIST_EMAIL_CAMPAIGNS`
>
> List a page of Brevo email campaigns, with filters for type, status, and dates. Results include campaign details and may include statistics; an empty campaigns array with count 0 is valid.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed.
>
> **type** `string ("classic" | "trigger")`
>
> Filter on the type of the campaigns.
>
> **limit** `integer`
>
> Number of documents per page.
>
> **offset** `integer`
>
> Index of the first document in the page. To paginate, increment by the `limit` value on each successive call until all records are fetched.
>
> **status** `string ("suspended" | "archive" | "sent" | "queued" | "draft" | "inProcess" | "inReview")`
>
> Filter on the status of the campaign.
>
> **endDate** `string`
>
> 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 either 'status' not passed and if passed is set to 'sent' )
>
> **startDate** `string`
>
> 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 either 'status' not passed and if passed is set to 'sent' )
>
> **statistics** `string ("globalStats" | "linksStats" | "statsByDomain")`
>
> Filter on the type of statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.
>
> **excludeHtmlContent** `boolean`
>
> 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.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Organization Users
>
> **Slug:** `BREVO_LIST_ORGANIZATION_USERS`
>
> List active and pending users in the connected Brevo organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Processes
>
> **Slug:** `BREVO_LIST_PROCESSES`
>
> List a bounded page of Brevo background processes for status monitoring.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Order processes by creation time: ascending or descending.
>
> **limit** `integer`
>
> Maximum number of processes to return (1-50).
>
> **offset** `integer`
>
> Zero-based index of the first process to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sender Domains
>
> **Slug:** `BREVO_LIST_SENDER_DOMAINS`
>
> List sender domains and their authentication and verification status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transactional Email Events
>
> **Slug:** `BREVO_LIST_TRANSACTIONAL_EMAIL_EVENTS`
>
> List one page of transactional email events with Brevo's complete filter set.
>
> #### Input Parameters
>
> **days** `integer`
>
> Number of past days to include, including today (1-90). Cannot be combined with start\_date or end\_date; Brevo defaults to 30 days when all date selectors are omitted.
>
> **sort** `string ("asc" | "desc")`
>
> Sort events by record creation in ascending or descending order.
>
> **tags** `string`
>
> Serialized tag array accepted by Brevo. Supply the serialized string; the HTTP client handles URL encoding because Brevo does not document the array serialization grammar.
>
> **email** `string`
>
> Return events for this recipient email address only.
>
> **event** `string ("bounces" | "hardBounces" | "softBounces" | "delivered" | "spam" | "requests" | "opened" | "clicks" | "invalid" | "deferred" | "blocked" | "unsubscribed" | "error" | "loadedByProxy")`
>
> Return only this transactional email event type.
>
> **limit** `integer`
>
> Maximum number of events to return in this page (0-5000). Defaults to 50 for an agent-manageable response.
>
> **offset** `integer`
>
> Zero-based index of the first event to return. Increase by limit for the next page; fewer than limit events indicates the end.
>
> **end\_date** `string`
>
> End of an explicit report range in YYYY-MM-DD format. Must be provided with start\_date, be on or after it, and keep the range within 90 days.
>
> **message\_id** `string`
>
> Return events for this exact Brevo message ID only.
>
> **start\_date** `string`
>
> Start of an explicit report range in YYYY-MM-DD format. Must be provided with end\_date and cannot be combined with days.
>
> **template\_id** `integer`
>
> Return events generated from this template ID only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transactional Emails
>
> **Slug:** `BREVO_LIST_TRANSACTIONAL_EMAILS`
>
> List a page of sent transactional email records, filtered by recipient email, template ID, or message ID. At least one of these filters is required; date and sorting options are also available.
>
> #### Input Parameters
>
> **sort** `string ("asc" | "desc")`
>
> Sort records by creation date in ascending or descending order.
>
> **email** `string`
>
> Recipient email address. Required when template\_id and message\_id are omitted.
>
> **limit** `integer`
>
> Maximum number of transactional emails to return in this page. Defaults to 50 for an agent-manageable response.
>
> **offset** `integer`
>
> Zero-based index of the first transactional email to return. Increase by limit for the next page.
>
> **end\_date** `string`
>
> End of the sent-date range in YYYY-MM-DD format. Must be provided with start\_date; the range cannot exceed 31 days.
>
> **message\_id** `string`
>
> Message ID of the sent email. Required when email and template\_id are omitted.
>
> **start\_date** `string`
>
> Start of the sent-date range in YYYY-MM-DD format. Must be provided with end\_date; the range cannot exceed 31 days.
>
> **template\_id** `integer`
>
> Template ID used to compose the email. Required when email and message\_id are omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Contacts from List
>
> **Slug:** `BREVO_REMOVE_CONTACTS_FROM_LIST`
>
> Remove selected contacts, or every contact, from one Brevo list.
>
> #### Input Parameters
>
> **emails** `array`
>
> Contact email addresses to remove. Supply exactly one contact selector.
>
> **list\_id** `integer` *required*
>
> ID of the existing Brevo list from which contacts will be removed.
>
> **contact\_ids** `array`
>
> Brevo contact IDs to remove. Supply exactly one contact selector.
>
> **all\_contacts** `boolean`
>
> Set true to remove every contact from the list. This may start an asynchronous Brevo process.
>
> **external\_ids** `array`
>
> Caller-owned external contact IDs to remove. Supply exactly one contact selector.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Email Campaign Now
>
> **Slug:** `BREVO_SEND_EMAIL_CAMPAIGN_NOW`
>
> Request immediate sending of an existing draft email campaign to its recipients. A successful response indicates Brevo accepted the request.
>
> #### Input Parameters
>
> **campaign\_id** `integer` *required*
>
> Positive integer ID of the draft email campaign to send immediately.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Email Campaign Test
>
> **Slug:** `BREVO_SEND_EMAIL_CAMPAIGN_TEST`
>
> Send a campaign test to explicit recipients or the account test list. Brevo permits at most 50 delivered test emails per day.
>
> #### Input Parameters
>
> **email\_to** `array`
>
> One through 50 explicit test recipients. Omit this field to send to the account test list. Every delivered test counts toward Brevo's maximum of 50 test emails per day.
>
> **campaign\_id** `integer` *required*
>
> Positive integer ID of the email campaign whose test rendering should be sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Transactional Email
>
> **Slug:** `BREVO_SEND_TRANSACTIONAL_EMAIL`
>
> Send or schedule one or many transactional emails through Brevo.
>
> #### Input Parameters
>
> **cc** `array`
>
> Carbon-copy recipients for a single message.
>
> **to** `array`
>
> Primary recipients. Required unless message\_versions is supplied and must be omitted when using message\_versions.
>
> **bcc** `array`
>
> Blind-carbon-copy recipients for a single message.
>
> **tags** `array`
>
> Tags used to categorize and filter transactional emails.
>
> **params** `object`
>
> Global template or inline-content personalization values.
>
> **sender** `object`
>
> Sender identity. Required for inline content; a template's sender is used when omitted with template\_id.
>
> **headers** `object`
>
> Non-standard email headers included in the delivered message, not HTTP request headers.
>
> **subject** `string`
>
> Email subject. Required for inline content; a template's subject is used when omitted with template\_id.
>
> **batch\_id** `string`
>
> UUIDv4 identifying a scheduled transactional-email batch. Requires scheduled\_at.
>
> **reply\_to** `object`
>
> Address that receives replies.
>
> **attachment** `array`
>
> Attachments supplied by absolute URL or base64 content. Old Template Language templates ignore attachments.
>
> **template\_id** `integer`
>
> ID of an active transactional template. Omit html\_content and text\_content because Brevo ignores them for template sends.
>
> **html\_content** `string`
>
> Inline HTML body. Required when template\_id is omitted; text\_content may accompany it as a plain-text alternative.
>
> **scheduled\_at** `string`
>
> Timezone-aware date-time for future delivery. Brevo may deliver up to five minutes late.
>
> **text\_content** `string`
>
> Optional plain-text alternative for an inline HTML email. Omit it when template\_id is provided.
>
> **message\_versions** `array`
>
> Personalized message variants. Supports up to 1,000 versions, 99 recipients per version, and 2,000 recipients across all versions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Transactional Template Test
>
> **Slug:** `BREVO_SEND_TRANSACTIONAL_TEMPLATE_TEST`
>
> Send a transactional template test to recipients or the account test list. Brevo permits at most 50 delivered test emails per day.
>
> #### Input Parameters
>
> **email\_to** `array`
>
> One through 50 explicit test recipients. Omit this field to send to the account test list. Every delivered test counts toward Brevo's maximum of 50 test emails per day.
>
> **template\_id** `integer` *required*
>
> Positive integer ID of the transactional template to test.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `BREVO_UPDATE_CONTACT`
>
> Update fields and list memberships for an existing Brevo contact.
>
> #### Input Parameters
>
> **ext\_id** `string`
>
> New caller-owned external identifier for the contact.
>
> **list\_ids** `array`
>
> Brevo list IDs to add to the contact's memberships.
>
> **attributes** `object`
>
> Existing Brevo attributes to update. Attribute names must be uppercase and already exist; mismatched value types are silently ignored. Setting attributes.EMAIL on a blocklisted contact removes email blocklisting and resubscribes it.
>
> **identifier** `string` *required*
>
> Contact email, numeric contact ID, external ID, SMS number, WhatsApp value, or landline value. String identifiers are URL-encoded safely.
>
> **force\_merge** `boolean`
>
> Destructive operation. When true and updated identifiers conflict, Brevo merges the contacts, keeps the most recently modified contact, and permanently deletes the other. Brevo defaults this to false and otherwise returns an error on conflict.
>
> **identifier\_type** `string ("email_id" | "contact_id" | "ext_id" | "phone_id" | "whatsapp_id" | "landline_number_id")`
>
> Identifier family. Omit only for an email or numeric contact ID; specify the matching type for external IDs, SMS, WhatsApp, and landline identifiers.
>
> **sms\_blacklisted** `boolean`
>
> Set true to block SMS campaigns or false to allow them for this contact.
>
> **unlink\_list\_ids** `array`
>
> Brevo list IDs to remove from the contact's memberships.
>
> **email\_blacklisted** `boolean`
>
> Set true to block email campaigns or false to allow them for this contact.
>
> **smtp\_blacklist\_sender** `array`
>
> Transactional sender email addresses forbidden for this contact. Brevo supports this only for email contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact List
>
> **Slug:** `BREVO_UPDATE_CONTACT_LIST`
>
> Rename an existing Brevo contact list, move it to a folder, or both.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the contact list.
>
> **list\_id** `integer` *required*
>
> Positive numeric ID of the contact list to update.
>
> **folder\_id** `integer`
>
> Positive numeric ID of the folder to move the contact list into.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Deal
>
> **Slug:** `BREVO_UPDATE_DEAL`
>
> Update a Brevo CRM deal's fields or complete association lists. Supplying either association list replaces every existing association of that type.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the deal.
>
> **deal\_id** `string` *required*
>
> ID of the Brevo CRM deal to update. The value is safely URL-encoded before it is sent.
>
> **attributes** `object`
>
> Custom deal attributes to replace or update, keyed by attributes configured in the Brevo account.
>
> **linked\_contacts\_ids** `array`
>
> Complete list of contact IDs to associate with the deal. This replaces all existing contact associations; an empty list removes them all.
>
> **linked\_companies\_ids** `array`
>
> Complete list of company IDs to associate with the deal. This replaces all existing company associations; an empty list removes them all.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Email Campaign
>
> **Slug:** `BREVO_UPDATE_EMAIL_CAMPAIGN`
>
> Updates an email campaign in Brevo using its unique identifier.
>
> #### Input Parameters
>
> **tag** `string`
>
> Tag of the campaign.
>
> **name** `string`
>
> Name of the campaign.
>
> **footer** `string`
>
> Email footer.
>
> **header** `string`
>
> Email header.
>
> **params** `object`
>
> Pass the set of attributes to customize the campaign. For example, \{'FNAME':'Joe', 'LNAME':'Doe'}. It's considered only if campaign is in New Template Language format.
>
> **sender** `object`
>
> Sender details.
>
> **htmlUrl** `string`
>
> URL to the HTML content. Mutually exclusive with html\_content.
>
> **replyTo** `string`
>
> Reply-to email address.
>
> **subject** `string`
>
> Subject of the campaign.
>
> **toField** `string`
>
> To field personalization (e.g., \{FNAME} \{LNAME}).
>
> **subjectA** `string`
>
> Subject for A variant in A/B test.
>
> **subjectB** `string`
>
> Subject for B variant in A/B test.
>
> **abTesting** `boolean`
>
> Enable A/B testing.
>
> **recurring** `boolean`
>
> Set campaign as recurring. Only applicable for trigger campaigns - allows contacts to receive the same trigger campaign multiple times.
>
> **splitRule** `integer`
>
> Split rule for A/B test (1-99).
>
> **recipients** `object`
>
> Recipient list details.
>
> **campaign\_id** `integer` *required*
>
> ID of the campaign to update.
>
> **htmlContent** `string`
>
> HTML content of the email. Mutually exclusive with html\_url.
>
> **previewText** `string`
>
> Preview text of the email.
>
> **scheduledAt** `string`
>
> Scheduled time for the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ).
>
> **utmCampaign** `string`
>
> UTM campaign tag.
>
> **winnerDelay** `integer`
>
> Winner delay in hours for A/B test (1-168).
>
> **increaseRate** `integer`
>
> Increase rate for IP warmup (1-100).
>
> **initialQuota** `integer`
>
> Initial quota for IP warmup.
>
> **mirrorActive** `boolean`
>
> Activate mirror link in the email.
>
> **updateFormId** `string`
>
> Update profile form ID.
>
> **attachmentUrl** `string`
>
> 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, msg, pub, mobi, epub, odt, ods, odp, odp.
>
> **ipWarmupEnable** `boolean`
>
> Enable IP warmup.
>
> **sendAtBestTime** `boolean`
>
> Send at best time (Brevo algorithm).
>
> **winnerCriteria** `string ("open" | "click")`
>
> Winner criteria for A/B test.
>
> **unsubscriptionPageId** `string`
>
> Unsubscription page ID.
>
> **inlineImageActivation** `boolean`
>
> Activate inline images in the email. Note: Limits campaign to under 5,000 contacts and 4MB total size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Email Campaign Status
>
> **Slug:** `BREVO_UPDATE_EMAIL_CAMPAIGN_STATUS`
>
> Apply a documented lifecycle status operation to an email campaign.
>
> #### Input Parameters
>
> **status** `string ("suspended" | "archive" | "darchive" | "sent" | "queued" | "replicate" | "replicateTemplate" | "cancel" | "draft")` *required*
>
> Required lifecycle operation to apply. cancel stops the campaign, and replicateTemplate is available only for template-type campaigns.
>
> **campaign\_id** `integer` *required*
>
> Positive integer ID of the email campaign to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Campaign Image
>
> **Slug:** `BREVO_UPLOAD_CAMPAIGN_IMAGE`
>
> Upload an image from a public URL to Brevo's campaign image gallery.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional name shown for the image in Brevo's campaign image gallery. Include the image file extension.
>
> **image\_url** `string` *required*
>
> Public HTTP or HTTPS URL of a jpeg, jpg, png, bmp, or gif image no larger than 2 MB that Brevo should add to the campaign image gallery.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
