# Brevo API Documentation ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For a complete documentation index, see https://developers.brevo.com/llms.txt - For full documentation content in one file, see https://developers.brevo.com/llms-full.txt - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server ## Docs - [Overview](https://developers.brevo.com/docs/getting-started.md): Build integrations with the Brevo API - [Quickstart](https://developers.brevo.com/docs/quickstart.md): Make your first API call in 3 steps - [Key concepts](https://developers.brevo.com/docs/how-it-works.md): Learn how the Brevo API works - [Postman workspace](https://developers.brevo.com/docs/postman.md): Test and explore the Brevo API using our Postman collection - [Authentication schemes](https://developers.brevo.com/docs/authentication-schemes.md): Choose between API key and OAuth 2.0 authentication for the Brevo API - [API key authentication](https://developers.brevo.com/docs/api-key-authentication.md): Generate and use an API key to authenticate your Brevo API requests - [OAuth 2.0](https://developers.brevo.com/docs/oauth.md): Token-based authentication for Brevo integrations that act on behalf of a user - [Quickstart](https://developers.brevo.com/docs/oauth-quickstart.md): Go from zero to a working OAuth flow in under 5 minutes - [Integration guide](https://developers.brevo.com/docs/oauth-integration-guide.md): Implement the OAuth 2.0 authorization code flow in your application - [Scopes](https://developers.brevo.com/docs/oauth-scopes.md): Permissions your OAuth app requests from a Brevo user - [CLI reference](https://developers.brevo.com/docs/cli-reference.md): Complete reference for the Brevo CLI — install, authenticate, and manage OAuth apps - [IP security & authorization](https://developers.brevo.com/docs/ip-security.md): Restrict API access to authorized IP addresses - [Rate limits](https://developers.brevo.com/docs/api-limits.md): Understand API rate limits and how to handle rate limit responses - [Rate limit headers](https://developers.brevo.com/docs/limit-headers.md): Understand and use rate limit response headers to manage API request throttling - [Platform quotas](https://developers.brevo.com/docs/platform-quotas.md): Quota limits for account objects and resources - [SDKs and libraries](https://developers.brevo.com/docs/api-clients.md): Official SDKs and client libraries for the Brevo API - [Node.js SDK](https://developers.brevo.com/guides/node-js.md): Learn how to integrate the Brevo API into your Node.js and browser applications. - [Node.js SDK Changelog](https://developers.brevo.com/guides/node-js/changelog.md): Release history for the @getbrevo/brevo Node.js SDK. - [Python SDK](https://developers.brevo.com/guides/python.md): Learn how to integrate the Brevo API into your Python applications. - [Python SDK Changelog](https://developers.brevo.com/guides/python/changelog.md): Release history for the brevo-python SDK. - [PHP SDK](https://developers.brevo.com/guides/php.md): Learn how to integrate the Brevo API into your PHP applications. - [PHP SDK Changelog](https://developers.brevo.com/guides/php/changelog.md): Release history for the getbrevo/brevo-php SDK. - [Brevo MCP Server](https://developers.brevo.com/docs/mcp-protocol.md): Use AI assistants to interact with your Brevo account using natural language — no manual navigation required. - [Tool configuration](https://developers.brevo.com/docs/integration-guide.md): Detailed setup instructions for connecting each supported AI tool to the Brevo MCP server. - [Connect to Cursor](https://developers.brevo.com/guides/connect-to-cursor.md): Learn how to connect the Brevo API documentation to Cursor via MCP server - [Send a transactional email](https://developers.brevo.com/docs/send-a-transactional-email.md): Send transactional emails with static or dynamic content using the Messaging API - [Batch send transactional emails](https://developers.brevo.com/docs/batch-send-transactional-emails.md): Send up to 1000 personalized email versions in a single API request - [Idempotency for batch emails](https://developers.brevo.com/docs/heterogenous-versions-batch-emails.md): Prevent duplicate emails by using idempotency keys in batch transactional email requests - [Schedule emails](https://developers.brevo.com/docs/schedule-batch-sendings.md) - [Using sandbox mode](https://developers.brevo.com/docs/using-sandbox-mode.md): Test transactional emails without sending them using sandbox mode - [Weekly event exports](https://developers.brevo.com/docs/bulk-fetch-all-your-transactional-activity.md): Export raw transactional event data for analytics - [SMTP relay integration](https://developers.brevo.com/docs/smtp-integration.md): Configure the SMTP relay to send transactional emails from your email client - [Postfix integration](https://developers.brevo.com/docs/using-the-smtp-relay-with-postfix.md) - [Node.js example](https://developers.brevo.com/docs/node-smtp-relay-example.md) - [Delete transactional logs](https://developers.brevo.com/docs/deleting-transactional-logs-based-on-recipient-address-to.md) - [Parse inbound email](https://developers.brevo.com/docs/inbound-parse-webhooks.md) - [Send transactional SMS](https://developers.brevo.com/docs/transactional-sms-endpoints.md) - [WhatsApp messages](https://developers.brevo.com/docs/whatsapp-messages.md): Send transactional WhatsApp messages using the Brevo API - [Manage your contacts in Brevo](https://developers.brevo.com/docs/synchronise-contact-lists.md): Learn how to create and update contacts using the Brevo API - [Getting started with Brevo Tracker](https://developers.brevo.com/guides/track-website-activity.md): Learn how to track website visitor behavior and build abandoned cart workflows. - [WhatsApp campaigns](https://developers.brevo.com/docs/whatsapp-campaigns-1.md): Learn how to create and manage WhatsApp campaigns using the Brevo API - [Weekly event exports](https://developers.brevo.com/docs/fetch-all-your-weekly-marketing-events.md) - [Getting started](https://developers.brevo.com/docs/how-to-use-webhooks.md) - [Retry mechanism](https://developers.brevo.com/docs/retry-mechanism.md) - [Payment webhooks](https://developers.brevo.com/docs/payment-webhooks.md) - [Marketing webhooks](https://developers.brevo.com/docs/marketing-webhooks.md) - [Transactional webhooks](https://developers.brevo.com/docs/transactional-webhooks.md) - [Loyalty webhooks](https://developers.brevo.com/docs/loyalty-webhooks.md): Real-time event reference for the Brevo Loyalty API. - [Batched webhooks](https://developers.brevo.com/docs/batch-webhooks.md) - [Secure webhook calls](https://developers.brevo.com/docs/secured-webhooks.md) - [Meetings and phone webhooks](https://developers.brevo.com/docs/meeting-webhooks.md) - [Push notification webhooks](https://developers.brevo.com/docs/push-notification-webhooks.md) - [Sales CRM webhooks](https://developers.brevo.com/docs/sales-crm-webhooks.md) - [Getting started](https://developers.brevo.com/docs/getting-started-with-conversations-api.md) - [Customize the chat widget](https://developers.brevo.com/docs/customize-the-widget.md) - [JavaScript API reference](https://developers.brevo.com/docs/javascript-api-reference.md) - [Conversations webhooks](https://developers.brevo.com/docs/conversations-webhooks.md): Create and manage Conversations webhooks in Conversations > Settings > Integrations > Webhooks - [Activate eCommerce app](https://developers.brevo.com/docs/add-the-ecommerce-app.md) - [Manage product categories](https://developers.brevo.com/docs/import-your-product-categories.md) - [Manage products](https://developers.brevo.com/docs/import-your-products.md) - [Import your orders](https://developers.brevo.com/docs/import-your-orders.md): Learn how to create and manage eCommerce orders via the Brevo API. - [Coupon collections](https://developers.brevo.com/docs/coupons-use-case.md) - [eCommerce tracker events](https://developers.brevo.com/docs/ecommerce-and-tracker-events.md) - [Loyalty](https://developers.brevo.com/docs/loyalty-overview.md): Build and operate reward programs programmatically with the Brevo Loyalty API. - [Set up a loyalty program](https://developers.brevo.com/docs/loyalty-setup.md): Learn how to create, configure, and publish a loyalty program via the Brevo API. - [Enroll members](https://developers.brevo.com/docs/loyalty-subscriptions.md): Learn how to subscribe Brevo contacts to a loyalty program. - [Credit & debit points](https://developers.brevo.com/docs/loyalty-transactions.md): Learn how to manage the transaction lifecycle for purchases, returns, and bonuses. - [Read member data](https://developers.brevo.com/docs/loyalty-member-data.md): Learn how to fetch a member's balance, tier status, vouchers, and transaction history. - [Best practices](https://developers.brevo.com/docs/loyalty-best-practices.md): Integration patterns, performance tips, and use cases for the Brevo Loyalty API. - [Custom objects management](https://developers.brevo.com/docs/custom-objects-management.md) - [Getting started](https://developers.brevo.com/docs/getting-started-with-the-brevo-tracker.md) - [JavaScript implementation](https://developers.brevo.com/docs/getting-started-with-js-implementation.md) - [Identify users](https://developers.brevo.com/docs/identify-users-js.md) - [Track page views](https://developers.brevo.com/docs/track-page-views-js.md) - [Track link clicks](https://developers.brevo.com/docs/track-link-clicks-js.md) - [Track custom events](https://developers.brevo.com/docs/track-custom-events-js.md) - [REST implementation](https://developers.brevo.com/docs/tracker-rest-implementation.md) - [Identify users](https://developers.brevo.com/docs/identify-users-rest.md) - [Track link clicks](https://developers.brevo.com/docs/track-link-clicks-rest.md) - [Track page views](https://developers.brevo.com/docs/track-page-views-rest.md) - [Track custom events](https://developers.brevo.com/docs/track-custom-events-rest.md) - [Events](https://developers.brevo.com/docs/events.md) - [Event endpoints](https://developers.brevo.com/docs/event-endpoints.md): Create individual or batched events to track contact interactions via the Events API. - [Senders and domains](https://developers.brevo.com/docs/getting-started-with-senders-and-domains.md) - [Sender creation and management](https://developers.brevo.com/docs/sender-creation-and-management.md) - [Domain creation and management](https://developers.brevo.com/docs/domain-creation-and-management.md) - [Domain authentication and validation](https://developers.brevo.com/docs/domain-authentication-and-verification.md) - [User activity logs](https://developers.brevo.com/docs/user-activity-logs.md) - [External feeds](https://developers.brevo.com/docs/external-feeds-1.md) - [Getting started](https://developers.brevo.com/docs/getting-started-with-external-feeds.md) - [External feeds management](https://developers.brevo.com/docs/external-feeds-management.md) - [Invited users](https://developers.brevo.com/docs/invited-users-management.md) - [Invited users management](https://developers.brevo.com/docs/invited-user-management.md) - [Getting started](https://developers.brevo.com/reference/quickstart-reference.md): Make your first API call in 3 steps ## API Docs - Email API > Transactional email [Send a transactional email](https://developers.brevo.com/reference/send-transac-email.md) - Email API > Transactional email [Get the list of transactional emails on the basis of allowed filters](https://developers.brevo.com/reference/get-transac-emails-list.md) - Email API > Transactional email [Get the personalized content of a sent transactional email](https://developers.brevo.com/reference/get-transac-email-content.md) - Email API > Transactional email [Delete scheduled emails by batchId or messageId](https://developers.brevo.com/reference/delete-scheduled-email-by-id.md) - Email API > Transactional email [Fetch scheduled emails by batchId or messageId](https://developers.brevo.com/reference/get-scheduled-email-by-id.md) - Email API > Transactional email [Delete hardbounces](https://developers.brevo.com/reference/delete-hardbounces.md) - Email API > Email statistics [Get your transactional email activity aggregated per day](https://developers.brevo.com/reference/get-smtp-report.md) - Email API > Email statistics [Get all your transactional email activity (unaggregated events)](https://developers.brevo.com/reference/get-email-event-report.md) - Email API > Email statistics [Get your transactional email activity aggregated over a period of time](https://developers.brevo.com/reference/get-aggregated-smtp-report.md) - Email API > Email logs [Delete an SMTP transactional log](https://developers.brevo.com/reference/delete-an-smtp-transactional-log.md) - Email API > Email templates [Get the list of email templates](https://developers.brevo.com/reference/get-smtp-templates.md) - Email API > Email templates [Delete an inactive email template](https://developers.brevo.com/reference/delete-smtp-template.md) - Email API > Email templates [Send a template to your test list](https://developers.brevo.com/reference/send-test-template.md) - Email API > Email templates [Generate the rendered preview of transactional template](https://developers.brevo.com/reference/post-preview-smtp-email-templates.md) - Email API > Email templates [Update an email template](https://developers.brevo.com/reference/update-smtp-template.md) - Email API > Email templates [Returns the template information](https://developers.brevo.com/reference/get-smtp-template.md) - Email API > Email templates [Create an email template](https://developers.brevo.com/reference/create-smtp-template.md) - Email API > Blocked email recipients [Get the list of blocked or unsubscribed transactional contacts](https://developers.brevo.com/reference/get-transac-blocked-contacts.md) - Email API > Blocked email recipients [Unblock or resubscribe a transactional contact](https://developers.brevo.com/reference/unblock-or-resubscribe-a-transactional-contact.md) - Email API > Blocked email domains [Add a new domain to the list of blocked domains](https://developers.brevo.com/reference/block-new-domain.md) - Email API > Blocked email domains [Unblock an existing domain from the list of blocked domains](https://developers.brevo.com/reference/delete-blocked-domain.md) - Email API > Blocked email domains [Get the list of blocked domains](https://developers.brevo.com/reference/get-blocked-domains.md) - Email API > Inbound parsing [Get the list of all the events for the received emails.](https://developers.brevo.com/reference/get-inbound-email-events.md) - Email API > Inbound parsing [Fetch all events history for one particular received email.](https://developers.brevo.com/reference/get-inbound-email-events-by-uuid.md) - Email API > Inbound parsing [Retrieve inbound attachment with download token.](https://developers.brevo.com/reference/get-inbound-email-attachment.md) - Transactional SMS > Transactional SMS [Send SMS message asynchronously to a mobile number](https://developers.brevo.com/reference/send-async-transactional-sms.md) - Transactional SMS > SMS statistics [Get your SMS activity aggregated over a period of time](https://developers.brevo.com/reference/get-transac-aggregated-sms-report.md) - Transactional SMS > SMS statistics [Get your SMS activity aggregated per day](https://developers.brevo.com/reference/get-transac-sms-report.md) - Transactional SMS > SMS statistics [Get all your SMS activity (unaggregated events)](https://developers.brevo.com/reference/get-sms-events.md) - Transactional WhatsApp > Transactional WhatsApp [Send a WhatsApp message](https://developers.brevo.com/reference/send-whatsapp-message.md) - Transactional WhatsApp > Transactional WhatsApp [Get all your WhatsApp activity (unaggregated events)](https://developers.brevo.com/reference/get-whatsapp-event-report.md) - Marketing Campaigns > Email Campaigns [Return all your created email campaigns](https://developers.brevo.com/reference/get-email-campaigns.md) - Marketing Campaigns > Email Campaigns [Create an email campaign](https://developers.brevo.com/reference/create-email-campaign.md) - Marketing Campaigns > Email Campaigns [Update an email campaign](https://developers.brevo.com/reference/update-email-campaign.md) - Marketing Campaigns > Email Campaigns [Delete an email campaign](https://developers.brevo.com/reference/delete-email-campaign.md) - Marketing Campaigns > Email Campaigns [Send an email campaign immediately, based on campaignId](https://developers.brevo.com/reference/send-email-campaign-now.md) - Marketing Campaigns > Email Campaigns [Send an email campaign to your test list](https://developers.brevo.com/reference/send-test-email.md) - Marketing Campaigns > Email Campaigns [Update an email campaign status](https://developers.brevo.com/reference/update-campaign-status.md) - Marketing Campaigns > Email Campaigns [Get a shared template url](https://developers.brevo.com/reference/get-shared-template-url.md) - Marketing Campaigns > Email Campaigns [Export the recipients of an email campaign](https://developers.brevo.com/reference/email-export-recipients.md) - Marketing Campaigns > Email Campaigns > Email Campaign Statistics [Send the report of a campaign](https://developers.brevo.com/reference/send-report.md) - Marketing Campaigns > Email Campaigns > Email Campaign Statistics [Get an email campaign report](https://developers.brevo.com/reference/get-email-campaign.md) - Marketing Campaigns > Email Campaigns > Email Campaign Statistics [Get an A/B test email campaign results](https://developers.brevo.com/reference/get-ab-test-campaign-result.md) - Marketing Campaigns > Email Campaigns > Content & Gallery [Upload an image to your account's image gallery](https://developers.brevo.com/reference/upload-image-to-gallery.md) - Marketing Campaigns > SMS Campaigns [Returns the information for all your created SMS campaigns](https://developers.brevo.com/reference/get-sms-campaigns.md) - Marketing Campaigns > SMS Campaigns [Creates an SMS campaign](https://developers.brevo.com/reference/create-sms-campaign.md) - Marketing Campaigns > SMS Campaigns [Get an SMS campaign](https://developers.brevo.com/reference/get-sms-campaign.md) - Marketing Campaigns > SMS Campaigns [Update an SMS campaign](https://developers.brevo.com/reference/update-sms-campaign.md) - Marketing Campaigns > SMS Campaigns [Delete an SMS campaign](https://developers.brevo.com/reference/delete-sms-campaign.md) - Marketing Campaigns > SMS Campaigns [Send your SMS campaign immediately](https://developers.brevo.com/reference/send-sms-campaign-now.md) - Marketing Campaigns > SMS Campaigns [Update a campaign's status](https://developers.brevo.com/reference/update-sms-campaign-status.md) - Marketing Campaigns > SMS Campaigns [Send a test SMS campaign](https://developers.brevo.com/reference/send-test-sms.md) - Marketing Campaigns > SMS Campaigns [Export an SMS campaign's recipients](https://developers.brevo.com/reference/request-sms-recipient-export.md) - Marketing Campaigns > SMS Campaigns [Send an SMS campaign's report](https://developers.brevo.com/reference/send-sms-report.md) - Marketing Campaigns > WhatsApp Campaigns [Get a WhatsApp campaign](https://developers.brevo.com/reference/get-whats-app-campaign.md) - Marketing Campaigns > WhatsApp Campaigns [Delete a WhatsApp campaign](https://developers.brevo.com/reference/delete-whats-app-campaign.md) - Marketing Campaigns > WhatsApp Campaigns [Update a WhatsApp campaign](https://developers.brevo.com/reference/update-whats-app-campaign.md) - Marketing Campaigns > WhatsApp Campaigns [Return all your created WhatsApp templates](https://developers.brevo.com/reference/get-whats-app-templates.md) - Marketing Campaigns > WhatsApp Campaigns [Create and Send a WhatsApp campaign](https://developers.brevo.com/reference/create-whats-app-campaign.md) - Marketing Campaigns > WhatsApp Campaigns [Return all your created WhatsApp campaigns](https://developers.brevo.com/reference/get-whats-app-campaigns.md) - Marketing Campaigns > WhatsApp Campaigns [Get your WhatsApp API account information](https://developers.brevo.com/reference/get-whats-app-config.md) - Marketing Campaigns > WhatsApp Campaigns > WhatsApp Templates [Create a WhatsApp template](https://developers.brevo.com/reference/create-whats-app-template.md) - Marketing Campaigns > WhatsApp Campaigns > WhatsApp Templates [Send your WhatsApp template for approval](https://developers.brevo.com/reference/send-whats-app-template-approval.md) - Contact Management > Attributes [Create contact attribute](https://developers.brevo.com/reference/create-attribute.md) - Contact Management > Attributes [Update contact attribute](https://developers.brevo.com/reference/update-attribute.md) - Contact Management > Attributes [List all attributes](https://developers.brevo.com/reference/get-attributes.md) - Contact Management > Attributes [Delete an attribute](https://developers.brevo.com/reference/delete-attribute.md) - Contact Management > Attributes [Delete a multiple-choice attribute option](https://developers.brevo.com/reference/delete-multi-attribute-options.md) - Contact Management > Lists [Create a list](https://developers.brevo.com/reference/create-list.md) - Contact Management > Lists [Get a list's details](https://developers.brevo.com/reference/get-list.md) - Contact Management > Lists [Get all the lists](https://developers.brevo.com/reference/get-lists.md) - Contact Management > Lists [Update a list](https://developers.brevo.com/reference/update-list.md) - Contact Management > Lists [Delete a list](https://developers.brevo.com/reference/delete-list.md) - Contact Management > Lists [Get contacts in a list](https://developers.brevo.com/reference/get-contacts-from-list.md) - Contact Management > Lists [Delete a contact from a list](https://developers.brevo.com/reference/remove-contact-from-list.md) - Contact Management > Lists [Add existing contacts to a list](https://developers.brevo.com/reference/add-contact-to-list.md) - Contact Management > Folders [Create a folder](https://developers.brevo.com/reference/create-folder.md) - Contact Management > Folders [Returns a folder's details](https://developers.brevo.com/reference/get-folder.md) - Contact Management > Folders [Update a folder](https://developers.brevo.com/reference/update-folder.md) - Contact Management > Folders [Get all folders](https://developers.brevo.com/reference/get-folders.md) - Contact Management > Folders [Delete a folder (and all its lists)](https://developers.brevo.com/reference/delete-folder.md) - Contact Management > Folders [Get lists in a folder](https://developers.brevo.com/reference/get-folder-lists.md) - Contact Management > Contacts [Get all the contacts](https://developers.brevo.com/reference/get-contacts.md) - Contact Management > Contacts [Create a contact](https://developers.brevo.com/reference/create-contact.md) - Contact Management > Contacts [Create Contact via DOI (Double-Opt-In) Flow](https://developers.brevo.com/reference/create-doi-contact.md) - Contact Management > Contacts [Get a contact's details](https://developers.brevo.com/reference/get-contact-info.md) - Contact Management > Contacts [Delete a contact](https://developers.brevo.com/reference/delete-contact.md) - Contact Management > Contacts [Update a contact](https://developers.brevo.com/reference/update-contact.md) - Contact Management > Contacts [Get email campaigns' statistics for a contact](https://developers.brevo.com/reference/get-contact-stats.md) - Contact Management > Contacts [Get all the segments](https://developers.brevo.com/reference/get-segments.md) - Contact Management > Contacts [Export contacts](https://developers.brevo.com/reference/request-contact-export.md) - Contact Management > Contacts [Import contacts](https://developers.brevo.com/reference/import-contacts.md) - Events [Get events](https://developers.brevo.com/reference/get-events.md) - Events [Create an event](https://developers.brevo.com/reference/create-event.md) - Events [Create events in batch](https://developers.brevo.com/reference/create-batch-events.md) - Object Management > Custom Objects [Create/Update object records in bulk](https://developers.brevo.com/reference/custom-objects/upsertrecords.md) - Object Management > Custom Objects [Get the list of object records and total records count for an object.](https://developers.brevo.com/reference/custom-objects/getrecords.md) - Object Management > Custom Objects [Delete multiple object records (up to 1000) asynchronously](https://developers.brevo.com/reference/custom-objects/batch-delete-object-records.md) - Accounts and Settings > Senders [Get email senders](https://developers.brevo.com/reference/get-senders.md) - Accounts and Settings > Senders [Create email sender](https://developers.brevo.com/reference/create-sender.md) - Accounts and Settings > Senders [Update a sender](https://developers.brevo.com/reference/update-sender.md) - Accounts and Settings > Senders [Delete a sender](https://developers.brevo.com/reference/delete-sender.md) - Accounts and Settings > Senders [Validate a sender using OTP](https://developers.brevo.com/reference/validate-sender-by-otp.md) - Accounts and Settings > Senders [Get all the dedicated IPs for your account](https://developers.brevo.com/reference/get-ips.md) - Accounts and Settings > Senders [Get all the dedicated IPs for a specific sender](https://developers.brevo.com/reference/get-ips-from-sender.md) - Accounts and Settings > Domains [Get the list of all sender domains](https://developers.brevo.com/reference/get-domains.md) - Accounts and Settings > Domains [Create a new sender domain](https://developers.brevo.com/reference/create-domain.md) - Accounts and Settings > Domains [Delete a sender domain](https://developers.brevo.com/reference/delete-domain.md) - Accounts and Settings > Domains [Get a sender domain configuration](https://developers.brevo.com/reference/get-domain-configuration.md) - Accounts and Settings > Domains [Authenticate a sender domain](https://developers.brevo.com/reference/authenticate-domain.md) - Accounts and Settings > Webhooks [Get all webhooks](https://developers.brevo.com/reference/get-webhooks.md) - Accounts and Settings > Webhooks [Create a webhook](https://developers.brevo.com/reference/create-webhook.md) - Accounts and Settings > Webhooks [Get a webhook details](https://developers.brevo.com/reference/get-webhook.md) - Accounts and Settings > Webhooks [Update a webhook](https://developers.brevo.com/reference/update-webhook.md) - Accounts and Settings > Webhooks [Delete a webhook](https://developers.brevo.com/reference/delete-webhook.md) - Accounts and Settings > Webhooks [Export webhook history](https://developers.brevo.com/reference/export-webhooks-history.md) - Accounts and Settings > Account [Get account details](https://developers.brevo.com/reference/get-account.md) - Accounts and Settings > Account [Get user activity logs](https://developers.brevo.com/reference/get-account-activity.md) - Accounts and Settings > Master Account [Get the list of all the sub-accounts of the master account.](https://developers.brevo.com/reference/get-the-list-of-all-the-sub-accounts-of-the-master-account.md) - Accounts and Settings > Master Account [Create a new sub-account under a master account.](https://developers.brevo.com/reference/create-a-new-sub-account-under-a-master-account.md) - Accounts and Settings > Master Account [Get sub-account details](https://developers.brevo.com/reference/get-sub-account-details.md) - Accounts and Settings > Master Account [Delete a sub-account](https://developers.brevo.com/reference/delete-a-sub-account.md) - Accounts and Settings > Master Account [Update sub-account plan](https://developers.brevo.com/reference/update-sub-account-plan.md) - Accounts and Settings > Master Account [Update sub-accounts plan](https://developers.brevo.com/reference/update-sub-accounts-plan.md) - Accounts and Settings > Master Account [Generate SSO token to access admin account](https://developers.brevo.com/reference/generate-sso-token-to-access-admin-account.md) - Accounts and Settings > Master Account [Generate SSO token to access sub-account](https://developers.brevo.com/reference/generate-sso-token-to-access-sub-account.md) - Accounts and Settings > Master Account [Get the details of requested master account](https://developers.brevo.com/reference/get-the-details-of-requested-master-account.md) - Accounts and Settings > Master Account [Create an API key for a sub-account](https://developers.brevo.com/reference/create-an-api-key-for-a-sub-account.md) - Accounts and Settings > Master Account [Enable/disable sub-account application(s)](https://developers.brevo.com/reference/enable-disable-sub-account-application-s.md) - Accounts and Settings > Master Account [Create a new group of sub-accounts](https://developers.brevo.com/reference/create-a-new-group-of-sub-accounts.md) - Accounts and Settings > Master Account [List of all IPs](https://developers.brevo.com/reference/list-of-all-i-ps.md) - Accounts and Settings > Master Account [Associate an IP to sub-accounts](https://developers.brevo.com/reference/associate-an-ip-to-sub-accounts.md) - Accounts and Settings > Master Account [Dissociate an IP to sub-accounts](https://developers.brevo.com/reference/dissociate-an-ip-to-sub-accounts.md) - Accounts and Settings > Master Account [GET a group details](https://developers.brevo.com/reference/get-a-group-details.md) - Accounts and Settings > Master Account [Update a group of sub-accounts](https://developers.brevo.com/reference/update-a-group-of-sub-accounts.md) - Accounts and Settings > Master Account [Delete a group](https://developers.brevo.com/reference/delete-a-group.md) - Accounts and Settings > Master Account [Delete sub-account from group](https://developers.brevo.com/reference/delete-sub-account-from-group.md) - Accounts and Settings > Master Account [Send invitation to an admin user](https://developers.brevo.com/reference/invite-admin-user.md) - Accounts and Settings > Master Account [Resend / cancel admin user invitation](https://developers.brevo.com/reference/resend-cancel-admin-user-invitation.md) - Accounts and Settings > Master Account [Revoke an admin user](https://developers.brevo.com/reference/revoke-an-admin-user.md) - Accounts and Settings > Master Account [Get the list of all admin users](https://developers.brevo.com/reference/get-corporate-invited-users-list.md) - Accounts and Settings > Master Account [Check admin user permissions](https://developers.brevo.com/reference/get-corporate-user-permission.md) - Accounts and Settings > Master Account [Change admin user permissions](https://developers.brevo.com/reference/change-admin-user-permissions.md) - Accounts and Settings > Master Account [Get the list of groups](https://developers.brevo.com/reference/get-sub-account-groups.md) - Accounts and Settings > User [Get the list of all your users](https://developers.brevo.com/reference/get-invited-users-list.md) - Accounts and Settings > User [Check user permission](https://developers.brevo.com/reference/get-user-permission.md) - Accounts and Settings > User [Revoke user permission](https://developers.brevo.com/reference/put-revoke-user-permission.md) - Accounts and Settings > User [Resend / Cancel invitation](https://developers.brevo.com/reference/putresendcancelinvitation.md) - Accounts and Settings > User [Send invitation to user](https://developers.brevo.com/reference/inviteuser.md) - Accounts and Settings > User [Update permission for a user](https://developers.brevo.com/reference/edit-user-permission.md) - Accounts and Settings > Process [Get background processes](https://developers.brevo.com/reference/get-processes.md) - Accounts and Settings > Process [Get process details](https://developers.brevo.com/reference/get-process.md) - Accounts and Settings > External Feeds [Get all external feeds](https://developers.brevo.com/reference/get-all-external-feeds.md) - Accounts and Settings > External Feeds [Create external feed](https://developers.brevo.com/reference/create-external-feed.md) - Accounts and Settings > External Feeds [Get external feed details](https://developers.brevo.com/reference/get-external-feed-by-uuid.md) - Accounts and Settings > External Feeds [Update external feed](https://developers.brevo.com/reference/update-external-feed.md) - Accounts and Settings > External Feeds [Delete external feed](https://developers.brevo.com/reference/delete-external-feed.md) - Sales CRM > Companies [Get all Companies](https://developers.brevo.com/reference/get-all-companies.md) - Sales CRM > Companies [Create a company](https://developers.brevo.com/reference/create-a-company.md) - Sales CRM > Companies [Get a company](https://developers.brevo.com/reference/get-a-company.md) - Sales CRM > Companies [Delete a company](https://developers.brevo.com/reference/delete-a-company.md) - Sales CRM > Companies [Update a company](https://developers.brevo.com/reference/update-a-company.md) - Sales CRM > Companies [Create a company/deal attribute](https://developers.brevo.com/reference/create-a-company-deal-attribute.md) - Sales CRM > Companies [Get company attributes](https://developers.brevo.com/reference/get-company-attributes.md) - Sales CRM > Companies [Link and Unlink company with contact and deal](https://developers.brevo.com/reference/link-and-unlink-company-with-contact-and-deal.md) - Sales CRM > Companies [Import companies(creation and updation)](https://developers.brevo.com/reference/import-companies-creation-and-updation.md) - Sales CRM > Deals [Get pipeline stages](https://developers.brevo.com/reference/get-pipeline-stages.md) - Sales CRM > Deals [Get a pipeline](https://developers.brevo.com/reference/get-a-pipeline.md) - Sales CRM > Deals [Get all pipelines](https://developers.brevo.com/reference/get-all-pipelines.md) - Sales CRM > Deals [Get deal attributes](https://developers.brevo.com/reference/get-deal-attributes.md) - Sales CRM > Deals [Get all deals](https://developers.brevo.com/reference/get-all-deals.md) - Sales CRM > Deals [Create a deal](https://developers.brevo.com/reference/create-a-deal.md) - Sales CRM > Deals [Get a deal](https://developers.brevo.com/reference/get-a-deal.md) - Sales CRM > Deals [Delete a deal](https://developers.brevo.com/reference/delete-a-deal.md) - Sales CRM > Deals [Update a deal](https://developers.brevo.com/reference/update-a-deal.md) - Sales CRM > Deals [Link and Unlink a deal with contacts and companies](https://developers.brevo.com/reference/link-and-unlink-a-deal-with-contacts-and-companies.md) - Sales CRM > Deals [Import deals(creation and updation)](https://developers.brevo.com/reference/import-deals-creation-and-updation.md) - Sales CRM > Tasks [Get all task types](https://developers.brevo.com/reference/get-all-task-types.md) - Sales CRM > Tasks [Get all tasks](https://developers.brevo.com/reference/get-all-tasks.md) - Sales CRM > Tasks [Create a task](https://developers.brevo.com/reference/create-a-task.md) - Sales CRM > Tasks [Get a task](https://developers.brevo.com/reference/get-a-task.md) - Sales CRM > Tasks [Delete a task](https://developers.brevo.com/reference/delete-a-task.md) - Sales CRM > Tasks [Update a task](https://developers.brevo.com/reference/update-a-task.md) - Sales CRM > Notes [Get all notes](https://developers.brevo.com/reference/get-all-notes.md) - Sales CRM > Notes [Create a note](https://developers.brevo.com/reference/create-a-note.md) - Sales CRM > Notes [Get a note](https://developers.brevo.com/reference/get-a-note.md) - Sales CRM > Notes [Update a note](https://developers.brevo.com/reference/update-a-note.md) - Sales CRM > Notes [Delete a note](https://developers.brevo.com/reference/delete-a-note.md) - Sales CRM > Files [Get all files](https://developers.brevo.com/reference/get-all-files.md) - Sales CRM > Files [Upload a file](https://developers.brevo.com/reference/upload-a-file.md) - Sales CRM > Files [Download a file](https://developers.brevo.com/reference/download-a-file.md) - Sales CRM > Files [Delete a file](https://developers.brevo.com/reference/delete-a-file.md) - Sales CRM > Files [Get file details](https://developers.brevo.com/reference/get-file-details.md) - Conversations > Messages [Delete a message sent by an agent](https://developers.brevo.com/reference/delete-a-message-sent-by-an-agent.md) - Conversations > Messages [Update a message sent by an agent](https://developers.brevo.com/reference/update-a-message-sent-by-an-agent.md) - Conversations > Messages [Get a message](https://developers.brevo.com/reference/get-a-message.md) - Conversations > Messages [Send a message as an agent](https://developers.brevo.com/reference/send-a-message-as-an-agent.md) - Conversations > Automated Messages [Delete an automated message](https://developers.brevo.com/reference/delete-an-automated-message.md) - Conversations > Automated Messages [Send an automated message to a visitor](https://developers.brevo.com/reference/send-an-automated-message-to-a-visitor.md) - Conversations > Automated Messages [Update an automated message](https://developers.brevo.com/reference/update-an-automated-message.md) - Conversations > Automated Messages [Get an automated message](https://developers.brevo.com/reference/get-an-automated-message.md) - Conversations > Status [Sets agent's status to online for 2-3 minutes](https://developers.brevo.com/reference/sets-agents-status-to-online-for-23-minutes.md) - Conversations > Visitors [Set visitor group assignment](https://developers.brevo.com/reference/set-visitor-group-assignment.md) - Ecommerce > Orders [Managing the status of the order](https://developers.brevo.com/reference/create-order.md) - Ecommerce > Orders [Create orders in batch](https://developers.brevo.com/reference/create-batch-order.md) - Ecommerce > Orders [Get order details](https://developers.brevo.com/reference/get-orders.md) - Ecommerce > Products [Create/Update a product](https://developers.brevo.com/reference/create-update-product.md) - Ecommerce > Products [Get a product's details](https://developers.brevo.com/reference/get-product-info.md) - Ecommerce > Products [Create products in batch](https://developers.brevo.com/reference/create-update-batch-products.md) - Ecommerce > Products [Return all your products](https://developers.brevo.com/reference/get-products.md) - Ecommerce > Products [Create a product alert for a contact](https://developers.brevo.com/reference/create-product-alert.md) - Ecommerce > Categories [Return all your categories](https://developers.brevo.com/reference/get-categories.md) - Ecommerce > Categories [Create/Update a category](https://developers.brevo.com/reference/create-update-category.md) - Ecommerce > Categories [Get a category details](https://developers.brevo.com/reference/get-category-info.md) - Ecommerce > Categories [Create categories in batch](https://developers.brevo.com/reference/create-update-batch-category.md) - Ecommerce > Revenue Attribution [Get detailed attribution metrics for a single Brevo campaign or workflow](https://developers.brevo.com/reference/get-detailed-attribution-metrics-for-a-single-brevo-campaign-or-workflow.md) - Ecommerce > Revenue Attribution [Get attributed product sales for a single Brevo campaign or workflow](https://developers.brevo.com/reference/get-attributed-product-sales-for-a-single-brevo-campaign-or-workflow.md) - Ecommerce > Revenue Attribution [Get attribution metrics for one or more Brevo campaigns or workflows](https://developers.brevo.com/reference/get-attribution-metrics-for-one-or-more-brevo-campaigns-or-workflows.md) - Ecommerce > Activation [Activate the eCommerce app](https://developers.brevo.com/reference/activate-the-e-commerce-app.md) - Ecommerce > Currencies [Set the ISO 4217 compliant display currency code for your Brevo account](https://developers.brevo.com/reference/set-config-display-currency.md) - Ecommerce > Currencies [Get the ISO 4217 compliant display currency code for your Brevo account](https://developers.brevo.com/reference/get-the-iso-4217-compliant-display-currency-code-for-your-brevo-account.md) - Ecommerce > Coupons [Get all your coupon collections](https://developers.brevo.com/reference/get-coupon-collections.md) - Ecommerce > Coupons [Create а coupon collection](https://developers.brevo.com/reference/create-coupon-collection.md) - Ecommerce > Coupons [Get a coupon collection by id](https://developers.brevo.com/reference/get-coupon-collection.md) - Ecommerce > Coupons [Update a coupon collection by id](https://developers.brevo.com/reference/update-coupon-collection.md) - Ecommerce > Coupons [Create coupons for a coupon collection](https://developers.brevo.com/reference/create-coupons.md) - Ecommerce > Payments [Create a payment request](https://developers.brevo.com/reference/payments/create-payment-request.md) - Ecommerce > Payments [Get payment request details](https://developers.brevo.com/reference/payments/get-payment-request.md) - Ecommerce > Payments [Delete a payment request.](https://developers.brevo.com/reference/payments/delete-payment-request.md) - Loyalty > Program [Get loyalty program list](https://developers.brevo.com/reference/get-lp-list.md) - Loyalty > Program [Create loyalty program](https://developers.brevo.com/reference/create-new-lp.md) - Loyalty > Program [Get loyalty program Info](https://developers.brevo.com/reference/get-loyalty-program-info.md) - Loyalty > Program [Update loyalty program](https://developers.brevo.com/reference/update-loyalty-program.md) - Loyalty > Program [Partially update loyalty program](https://developers.brevo.com/reference/partially-update-loyalty-program.md) - Loyalty > Program [Delete Loyalty Program](https://developers.brevo.com/reference/delete-loyalty-program.md) - Loyalty > Program [Publish loyalty program](https://developers.brevo.com/reference/publish-loyalty-program.md) - Loyalty > Program [Create subscription](https://developers.brevo.com/reference/subscribe-to-loyalty-program.md) - Loyalty > Program [Create subscription member](https://developers.brevo.com/reference/subscribe-member-to-a-subscription.md) - Loyalty > Program [Delete subscription member](https://developers.brevo.com/reference/delete-contact-members.md) - Loyalty > Program [Delete subscription](https://developers.brevo.com/reference/delete-contact-subscription.md) - Loyalty > Program [Get Subscription Data](https://developers.brevo.com/reference/get-parameter-subscription-info.md) - Loyalty > Reward [Get code count](https://developers.brevo.com/reference/get-code-count.md) - Loyalty > Reward [Get voucher for a contact](https://developers.brevo.com/reference/get-voucher-for-a-contact.md) - Loyalty > Reward [Get Reward Page API](https://developers.brevo.com/reference/get-reward-page-api.md) - Loyalty > Reward [Create a reward](https://developers.brevo.com/reference/create-reward.md) - Loyalty > Reward [Get reward information](https://developers.brevo.com/reference/get-reward-information.md) - Loyalty > Reward [Create a voucher](https://developers.brevo.com/reference/create-voucher.md) - Loyalty > Reward [Create redeem voucher request](https://developers.brevo.com/reference/redeem-voucher.md) - Loyalty > Reward [Complete redeem voucher request](https://developers.brevo.com/reference/complete-redeem-transaction.md) - Loyalty > Reward [Revoke vouchers](https://developers.brevo.com/reference/revoke-vouchers.md) - Loyalty > Reward [Validate a reward](https://developers.brevo.com/reference/validate-reward.md) - Loyalty > Balance [Get balance definition list](https://developers.brevo.com/reference/get-balance-definition-list.md) - Loyalty > Balance [Create balance definition](https://developers.brevo.com/reference/create-balance-definition.md) - Loyalty > Balance [Get balance definition](https://developers.brevo.com/reference/get-balance-definition.md) - Loyalty > Balance [Update balance definition](https://developers.brevo.com/reference/update-balance-definition.md) - Loyalty > Balance [Delete balance definition](https://developers.brevo.com/reference/delete-balance-definition.md) - Loyalty > Balance [Create balance limits](https://developers.brevo.com/reference/create-balance-limit.md) - Loyalty > Balance [Get balance limits](https://developers.brevo.com/reference/get-balance-limit.md) - Loyalty > Balance [Delete balance limit](https://developers.brevo.com/reference/delete-balance-limit.md) - Loyalty > Balance [Updates balance limit](https://developers.brevo.com/reference/update-balance-limit.md) - Loyalty > Balance [Get subscription balances](https://developers.brevo.com/reference/get-subscription-balances.md) - Loyalty > Balance [Create subscription balances](https://developers.brevo.com/reference/create-subscription-balances.md) - Loyalty > Balance [Get balance list](https://developers.brevo.com/reference/get-contact-balances.md) - Loyalty > Balance [Create new transaction](https://developers.brevo.com/reference/begin-transaction.md) - Loyalty > Balance [Complete transaction](https://developers.brevo.com/reference/complete-transaction.md) - Loyalty > Balance [Cancel transaction](https://developers.brevo.com/reference/cancel-transaction.md) - Loyalty > Balance [Create balance order](https://developers.brevo.com/reference/create-balance-order.md) - Loyalty > Balance [Get Active Balances API](https://developers.brevo.com/reference/get-active-balances-api.md) - Loyalty > Balance [Get Transaction History API](https://developers.brevo.com/reference/get-transaction-history-api.md) - Loyalty > Tier [Create a tier group](https://developers.brevo.com/reference/create-tier-group.md) - Loyalty > Tier [List tier groups](https://developers.brevo.com/reference/get-list-of-tier-groups.md) - Loyalty > Tier [Update tier group](https://developers.brevo.com/reference/update-tier-group.md) - Loyalty > Tier [Delete tier group](https://developers.brevo.com/reference/delete-tier-group.md) - Loyalty > Tier [Get tier group](https://developers.brevo.com/reference/get-tier-group.md) - Loyalty > Tier [List tiers](https://developers.brevo.com/reference/get-loyalty-program-tier.md) - Loyalty > Tier [Create a tier](https://developers.brevo.com/reference/create-tier-for-tier-group.md) - Loyalty > Tier [Delete tier](https://developers.brevo.com/reference/delete-tier.md) - Loyalty > Tier [Update tier](https://developers.brevo.com/reference/update-tier.md) - Loyalty > Tier [Assign a tier](https://developers.brevo.com/reference/add-subscription-to-tier.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.brevo.com/openapi.json) - [OpenAPI YAML](https://developers.brevo.com/openapi.yaml)