# Brevo API Documentation

This is the complete API documentation for connecting to the Brevo API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Brevo connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/brevo/actions/{actionSlug}/run
```

## Brevo actions

- POST `activate-ecommerce` Activate Ecommerce
- POST `add-contacts-to-list` Add Contacts to List
- POST `assign-loyalty-tier` Assign Loyalty Tier
- POST `associate-corporate-sub-account-ip` Associate Corporate Sub Account IP
- PUT `authenticate-sender-domain` Authenticate Sender Domain
- POST `cancel-loyalty-transaction` Cancel Loyalty Transaction
- POST `complete-loyalty-redeem-transaction` Complete Loyalty Redeem Transaction
- POST `complete-loyalty-transaction` Complete Loyalty Transaction
- POST `create-blocked-domain` Create Blocked Domain
- POST `create-categories-batch` Create Categories Batch
- POST `create-category` Create Category
- POST `create-company` Create Company
- POST `create-contact` Create Contact
- POST `create-contact-attribute` Create Contact Attribute
- POST `create-contact-folder` Create Contact Folder
- POST `create-contacts-batch` Create Contacts Batch
- POST `create-conversation-message` Create Conversation Message
- POST `create-corporate-group` Create Corporate Group
- POST `create-corporate-sso-token` Create Corporate SSO Token
- POST `create-corporate-sub-account` Create Corporate Sub Account
- POST `create-corporate-sub-account-api-key` Create Corporate Sub Account API Key
- POST `create-corporate-sub-account-sso-token` Create Corporate Sub Account SSO Token
- POST `create-coupon-collection` Create Coupon Collection
- POST `create-coupons` Create Coupons
- POST `create-crm-attribute` Create CRM Attribute
- POST `create-crm-file` Create CRM File
- POST `create-crm-note` Create CRM Note
- POST `create-crm-task` Create CRM Task
- POST `create-deal` Create Deal
- POST `create-email-campaign` Create Email Campaign
- POST `create-event` Create Event
- POST `create-events-batch` Create Events Batch
- POST `create-feed` Create Feed
- POST `create-list` Create List
- POST `create-loyalty-balance-definition` Create Loyalty Balance Definition
- POST `create-loyalty-balance-limit` Create Loyalty Balance Limit
- POST `create-loyalty-order` Create Loyalty Order
- POST `create-loyalty-program` Create Loyalty Program
- POST `create-loyalty-reward` Create Loyalty Reward
- POST `create-loyalty-subscription-balances` Create Loyalty Subscription Balances
- POST `create-loyalty-subscription-member` Create Loyalty Subscription Member
- POST `create-loyalty-tier` Create Loyalty Tier
- POST `create-loyalty-tier-group` Create Loyalty Tier Group
- POST `create-loyalty-transaction` Create Loyalty Transaction
- POST `create-loyalty-voucher` Create Loyalty Voucher
- POST `create-order-status` Create Order Status
- POST `create-orders-batch` Create Orders Batch
- POST `create-payment-request` Create Payment Request
- POST `create-product` Create Product
- POST `create-product-alert` Create Product Alert
- POST `create-products-batch` Create Products Batch
- POST `create-pushed-conversation-message` Create Pushed Conversation Message
- POST `create-sender` Create Sender
- POST `create-sender-domain` Create Sender Domain
- POST `create-sms-campaign` Create SMS Campaign
- POST `create-smtp-template` Create SMTP Template
- POST `create-webhook` Create Webhook
- POST `create-whats-app-campaign` Create WhatsApp Campaign
- POST `create-whats-app-template` Create WhatsApp Template
- DELETE `delete-blocked-contact` Delete Blocked Contact
- DELETE `delete-blocked-domain` Delete Blocked Domain
- DELETE `delete-company` Delete Company
- DELETE `delete-contact` Delete Contact
- DELETE `delete-contact-attribute` Delete Contact Attribute
- DELETE `delete-contact-attribute-option` Delete Contact Attribute Option
- DELETE `delete-contact-folder` Delete Contact Folder
- DELETE `delete-conversation-message` Delete Conversation Message
- DELETE `delete-corporate-group` Delete Corporate Group
- DELETE `delete-corporate-sub-account` Delete Corporate Sub Account
- DELETE `delete-crm-attribute` Delete CRM Attribute
- DELETE `delete-crm-file` Delete CRM File
- DELETE `delete-crm-note` Delete CRM Note
- DELETE `delete-crm-task` Delete CRM Task
- DELETE `delete-deal` Delete Deal
- DELETE `delete-email-campaign` Delete Email Campaign
- DELETE `delete-feed` Delete Feed
- POST `delete-hard-bounces` Delete Hard Bounces
- DELETE `delete-list` Delete List
- DELETE `delete-loyalty-balance-definition` Delete Loyalty Balance Definition
- DELETE `delete-loyalty-balance-limit` Delete Loyalty Balance Limit
- DELETE `delete-loyalty-contact-subscription` Delete Loyalty Contact Subscription
- DELETE `delete-loyalty-program` Delete Loyalty Program
- DELETE `delete-loyalty-subscription-members` Delete Loyalty Subscription Members
- DELETE `delete-loyalty-tier` Delete Loyalty Tier
- DELETE `delete-loyalty-tier-group` Delete Loyalty Tier Group
- DELETE `delete-object-records-batch` Delete Object Records Batch
- DELETE `delete-payment-request` Delete Payment Request
- DELETE `delete-pushed-conversation-message` Delete Pushed Conversation Message
- DELETE `delete-scheduled-email` Delete Scheduled Email
- DELETE `delete-sender` Delete Sender
- DELETE `delete-sender-domain` Delete Sender Domain
- DELETE `delete-sms-campaign` Delete SMS Campaign
- DELETE `delete-smtp-log` Delete SMTP Log
- DELETE `delete-smtp-template` Delete SMTP Template
- DELETE `delete-webhook` Delete Webhook
- DELETE `delete-whats-app-campaign` Delete WhatsApp Campaign
- PUT `dissociate-corporate-sub-account-ip` Dissociate Corporate Sub Account IP
- POST `export-contacts` Export Contacts
- POST `export-email-campaign-recipients` Export Email Campaign Recipients
- POST `export-sms-campaign-recipients` Export SMS Campaign Recipients
- POST `export-webhook-history` Export Webhook History
- GET `get-account` Get Account
- GET `get-category` Get Category
- GET `get-company` Get Company
- GET `get-contact` Get Contact
- GET `get-contact-campaign-stats` Get Contact Campaign Stats
- GET `get-contact-folder` Get Contact Folder
- GET `get-conversation-message` Get Conversation Message
- GET `get-corporate-group` Get Corporate Group
- GET `get-corporate-invited-user-permissions` Get Corporate Invited User Permissions
- GET `get-corporate-sub-account` Get Corporate Sub Account
- GET `get-corporate-user-permissions` Get Corporate User Permissions
- GET `get-coupon-collection` Get Coupon Collection
- GET `get-crm-file` Get CRM File
- GET `get-crm-file-metadata` Get CRM File Metadata
- GET `get-crm-note` Get CRM Note
- GET `get-crm-pipeline` Get CRM Pipeline
- GET `get-crm-task` Get CRM Task
- GET `get-deal` Get Deal
- GET `get-ecommerce-attribution-metric-detail` Get Ecommerce Attribution Metric Detail
- GET `get-ecommerce-display-currency` Get Ecommerce Display Currency
- GET `get-email-campaign` Get Email Campaign
- GET `get-email-campaign-ab-test-result` Get Email Campaign AB Test Result
- GET `get-email-campaign-shared-url` Get Email Campaign Shared URL
- GET `get-feed` Get Feed
- GET `get-inbound-attachment` Get Inbound Attachment
- GET `get-inbound-event` Get Inbound Event
- GET `get-list` Get List
- GET `get-loyalty-active-balances` Get Loyalty Active Balances
- GET `get-loyalty-balance-definition` Get Loyalty Balance Definition
- GET `get-loyalty-balance-limit` Get Loyalty Balance Limit
- GET `get-loyalty-code-count` Get Loyalty Code Count
- GET `get-loyalty-offers` Get Loyalty Offers
- GET `get-loyalty-program` Get Loyalty Program
- GET `get-loyalty-programs` Get Loyalty Programs
- GET `get-loyalty-reward` Get Loyalty Reward
- GET `get-loyalty-subscription-balances` Get Loyalty Subscription Balances
- GET `get-loyalty-subscription-data` Get Loyalty Subscription Data
- GET `get-loyalty-tier-group` Get Loyalty Tier Group
- GET `get-loyalty-vouchers` Get Loyalty Vouchers
- GET `get-master-account` Get Master Account
- GET `get-organization-user-permissions` Get Organization User Permissions
- GET `get-payment-request` Get Payment Request
- GET `get-process` Get Process
- GET `get-product` Get Product
- GET `get-pushed-conversation-message` Get Pushed Conversation Message
- GET `get-scheduled-email` Get Scheduled Email
- GET `get-sender-domain` Get Sender Domain
- GET `get-sms-campaign` Get SMS Campaign
- GET `get-smtp-aggregated-report` Get SMTP Aggregated Report
- GET `get-smtp-template` Get SMTP Template
- GET `get-transactional-email-content` Get Transactional Email Content
- GET `get-transactional-sms-aggregated-report` Get Transactional SMS Aggregated Report
- GET `get-webhook` Get Webhook
- GET `get-whats-app-campaign` Get WhatsApp Campaign
- GET `get-whats-app-campaign-config` Get WhatsApp Campaign Config
- POST `import-companies` Import Companies
- POST `import-contacts` Import Contacts
- POST `import-deals` Import Deals
- POST `invite-corporate-admin-user` Invite Corporate Admin User
- POST `invite-organization-user` Invite Organization User
- PUT `link-unlink-company` Link Unlink Company
- PUT `link-unlink-deal` Link Unlink Deal
- GET `list-blocked-contacts` List Blocked Contacts
- GET `list-blocked-domains` List Blocked Domains
- GET `list-categories` List Categories
- GET `list-companies` List Companies
- GET `list-contact-attributes` List Contact Attributes
- GET `list-contact-folders` List Contact Folders
- GET `list-contacts` List Contacts
- GET `list-contacts-in-list` List Contacts in List
- GET `list-corporate-groups` List Corporate Groups
- GET `list-corporate-invited-users` List Corporate Invited Users
- GET `list-corporate-i-ps` List Corporate IPs
- GET `list-corporate-sub-accounts` List Corporate Sub Accounts
- GET `list-coupon-collections` List Coupon Collections
- GET `list-crm-company-attributes` List CRM Company Attributes
- GET `list-crm-deal-attributes` List CRM Deal Attributes
- GET `list-crm-files` List CRM Files
- GET `list-crm-notes` List CRM Notes
- GET `list-crm-pipeline-details` List CRM Pipeline Details
- GET `list-crm-pipelines` List CRM Pipelines
- GET `list-crm-task-types` List CRM Task Types
- GET `list-crm-tasks` List CRM Tasks
- GET `list-deals` List Deals
- GET `list-ecommerce-attributed-products` List Ecommerce Attributed Products
- GET `list-ecommerce-attribution-metrics` List Ecommerce Attribution Metrics
- GET `list-email-campaigns` List Email Campaigns
- GET `list-events` List Events
- GET `list-feeds` List Feeds
- GET `list-inbound-events` List Inbound Events
- GET `list-lists` List Lists
- GET `list-lists-in-folder` List Lists in Folder
- GET `list-loyalty-balance-definitions` List Loyalty Balance Definitions
- GET `list-loyalty-contact-balances` List Loyalty Contact Balances
- GET `list-loyalty-tier-groups` List Loyalty Tier Groups
- GET `list-loyalty-tiers` List Loyalty Tiers
- GET `list-loyalty-transaction-history` List Loyalty Transaction History
- GET `list-object-records` List Object Records
- GET `list-orders` List Orders
- GET `list-organization-activities` List Organization Activities
- GET `list-organization-invited-users` List Organization Invited Users
- GET `list-processes` List Processes
- GET `list-products` List Products
- GET `list-segments` List Segments
- GET `list-sender-domains` List Sender Domains
- GET `list-sender-i-ps` List Sender IPs
- GET `list-sender-i-ps-by-sender` List Sender IPs by Sender
- GET `list-senders` List Senders
- GET `list-sms-campaigns` List SMS Campaigns
- GET `list-sms-templates` List SMS Templates
- GET `list-smtp-events` List SMTP Events
- GET `list-smtp-reports` List SMTP Reports
- GET `list-smtp-templates` List SMTP Templates
- GET `list-transactional-emails` List Transactional Emails
- GET `list-transactional-sms-events` List Transactional SMS Events
- GET `list-transactional-sms-reports` List Transactional SMS Reports
- GET `list-webhooks` List Webhooks
- GET `list-whats-app-campaigns` List WhatsApp Campaigns
- GET `list-whats-app-events` List WhatsApp Events
- GET `list-whats-app-templates` List WhatsApp Templates
- PUT `partially-update-loyalty-program` Partially Update Loyalty Program
- POST `ping-conversation-agent-online` Ping Conversation Agent Online
- POST `preview-smtp-template` Preview SMTP Template
- POST `publish-loyalty-program` Publish Loyalty Program
- POST `redeem-loyalty-voucher` Redeem Loyalty Voucher
- DELETE `remove-contacts-from-list` Remove Contacts from List
- DELETE `revoke-corporate-user` Revoke Corporate User
- DELETE `revoke-loyalty-vouchers` Revoke Loyalty Vouchers
- PUT `revoke-organization-user-permission` Revoke Organization User Permission
- POST `send-async-transactional-sms` Send Async Transactional SMS
- POST `send-double-opt-in-confirmation` Send Double Opt-In Confirmation
- POST `send-email-campaign-now` Send Email Campaign Now
- POST `send-email-campaign-report` Send Email Campaign Report
- POST `send-email-campaign-test` Send Email Campaign Test
- POST `send-sms-campaign-now` Send SMS Campaign Now
- POST `send-sms-campaign-report` Send SMS Campaign Report
- POST `send-sms-campaign-test` Send SMS Campaign Test
- POST `send-smtp-template-test` Send SMTP Template Test
- POST `send-transactional-email` Send Transactional Email
- POST `send-transactional-sms` Send Transactional SMS
- POST `send-whats-app-message` Send WhatsApp Message
- POST `send-whats-app-template-approval` Send WhatsApp Template Approval
- POST `subscribe-loyalty-program` Subscribe Loyalty Program
- PUT `toggle-corporate-sub-account-applications` Toggle Corporate Sub Account Applications
- PUT `unlink-corporate-group-sub-accounts` Unlink Corporate Group Sub Accounts
- PUT `update-company` Update Company
- PUT `update-contact` Update Contact
- PUT `update-contact-attribute` Update Contact Attribute
- PUT `update-contact-folder` Update Contact Folder
- PUT `update-conversation-message` Update Conversation Message
- PUT `update-conversation-visitor-group` Update Conversation Visitor Group
- PUT `update-corporate-group` Update Corporate Group
- PUT `update-corporate-sub-account-plan` Update Corporate Sub Account Plan
- PUT `update-corporate-sub-accounts-plan` Update Corporate Sub Accounts Plan
- PUT `update-corporate-user-invitation` Update Corporate User Invitation
- PUT `update-corporate-user-permissions` Update Corporate User Permissions
- PUT `update-coupon-collection` Update Coupon Collection
- PUT `update-crm-attribute` Update CRM Attribute
- PUT `update-crm-note` Update CRM Note
- PUT `update-crm-task` Update CRM Task
- PUT `update-deal` Update Deal
- PUT `update-ecommerce-display-currency` Update Ecommerce Display Currency
- PUT `update-email-campaign` Update Email Campaign
- PUT `update-email-campaign-status` Update Email Campaign Status
- PUT `update-feed` Update Feed
- PUT `update-list` Update List
- PUT `update-loyalty-balance-definition` Update Loyalty Balance Definition
- PUT `update-loyalty-balance-limit` Update Loyalty Balance Limit
- PUT `update-loyalty-program` Update Loyalty Program
- PUT `update-loyalty-tier` Update Loyalty Tier
- PUT `update-loyalty-tier-group` Update Loyalty Tier Group
- PUT `update-organization-user-invitation` Update Organization User Invitation
- PUT `update-organization-user-permissions` Update Organization User Permissions
- PUT `update-pushed-conversation-message` Update Pushed Conversation Message
- PUT `update-sender` Update Sender
- PUT `update-sms-campaign` Update SMS Campaign
- PUT `update-sms-campaign-status` Update SMS Campaign Status
- PUT `update-smtp-template` Update SMTP Template
- PUT `update-webhook` Update Webhook
- PUT `update-whats-app-campaign` Update WhatsApp Campaign
- POST `upload-email-campaign-image` Upload Email Campaign Image
- POST `upsert-object-records-batch` Upsert Object Records Batch
- POST `validate-loyalty-reward` Validate Loyalty Reward
- PUT `validate-sender` Validate Sender