> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Brevo

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools | Status |
    | - | - |
    | Pre-built authorization (API Key) | ✅ |
    | Pre-built authorization UI | ✅ |
    | Custom authorization UI | ✅ |
    | End-user authorization guide | 🚫 |
    | Expired credentials detection | ✅ |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools | Status |
    | - | - |
    | Pre-built integrations | ✅ |
    | API unification | ✅ |
    | 2-way sync | ✅ |
    | Webhooks from Nango on data modifications | ✅ |
    | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
    | Proxy requests | ✅ |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools | Status |
    | - | - |
    | HTTP request logging | ✅ |
    | End-to-end type safety | ✅ |
    | Data runtime validation | ✅ |
    | OpenTelemetry export | ✅ |
    | Slack alerts on errors | ✅ |
    | Integration status API | ✅ |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools | Status |
    | - | - |
    | Create or customize use-cases | ✅ |
    | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
    | Per-customer configurations | ✅ |
  </Accordion>
</AccordionGroup>

### Others

| Function name | Description | Type | Source code |
| - | - | - | - |
| `add-contacts-to-list` | Bulk-add one or more existing contacts, identified by email, to a Brevo contact list. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/add-contacts-to-list.ts) |
| `create-company` | Create a new company (CRM object). | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-company.ts) |
| `create-contact-attribute` | Define a new custom contact attribute (field) on the account contact schema. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-contact-attribute.ts) |
| `create-contact-folder` | Create a new contact folder to organize contact lists | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-contact-folder.ts) |
| `create-contact-list` | Create a new contact list inside a folder. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-contact-list.ts) |
| `create-contact` | Create a new contact | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-contact.ts) |
| `create-deal` | Create a new deal. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-deal.ts) |
| `create-email-campaign` | Create a draft email (classic) campaign | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-email-campaign.ts) |
| `create-email-template` | Create a new transactional email template | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-email-template.ts) |
| `create-sms-campaign` | Create a draft SMS campaign. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/create-sms-campaign.ts) |
| `delete-company` | Delete a company. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-company.ts) |
| `delete-contact-attribute` | Permanently delete a custom contact attribute from the account schema by category and name. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-contact-attribute.ts) |
| `delete-contact-folder` | Delete a contact folder and all contact lists it contains. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-contact-folder.ts) |
| `delete-contact-list` | Delete a contact list. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-contact-list.ts) |
| `delete-contact` | Delete a contact | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-contact.ts) |
| `delete-deal` | Delete a deal | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-deal.ts) |
| `delete-email-campaign` | Delete an email campaign. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-email-campaign.ts) |
| `delete-email-template` | Permanently delete an inactive transactional email template by its numeric ID. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-email-template.ts) |
| `delete-sms-campaign` | Delete an SMS campaign. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/delete-sms-campaign.ts) |
| `get-company` | Retrieve a single company by ID. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-company.ts) |
| `get-contact-folder` | Retrieve a single contact folder's details by ID. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-contact-folder.ts) |
| `get-contact-full-profile` | Get a 360-degree view of a contact: the contact record, its linked CRM companies and its linked CRM deals in one call. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-contact-full-profile.ts) |
| `get-contact-list` | Retrieve the details of a single Brevo contact list by its ID | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-contact-list.ts) |
| `get-contact` | Retrieve a single contact by email or numeric ID. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-contact.ts) |
| `get-deal` | Retrieve a single deal by ID | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-deal.ts) |
| `get-email-campaign` | Retrieve a single email campaign's full detail, including delivery statistics | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-email-campaign.ts) |
| `get-email-template` | Retrieve a single transactional email template's detail. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-email-template.ts) |
| `get-sms-campaign` | Retrieve a single SMS campaign by ID, including its content, recipients, status, and delivery statistics. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-sms-campaign.ts) |
| `get-transactional-email-events` | Retrieve the transactional email event log (requests, delivered, opens, clicks, bounces, etc.) for the account. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/get-transactional-email-events.ts) |
| `link-unlink-company-contacts` | Link or unlink contacts and/or deals to a company in a single request. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/link-unlink-company-contacts.ts) |
| `link-unlink-deal-relations` | Link or unlink contacts and/or companies to a deal. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/link-unlink-deal-relations.ts) |
| `list-companies` | List companies (Brevo CRM company objects) with pagination, sorting, and optional filters. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-companies.ts) |
| `list-company-attributes` | List the schema of attributes available on company (CRM) objects. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-company-attributes.ts) |
| `list-contact-attributes` | List the account's contact attribute schema (built-in and custom fields such as FIRSTNAME/LASTNAME). | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-contact-attributes.ts) |
| `list-contact-folders` | List the account's contact folders (the organizational containers for lists) | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-contact-folders.ts) |
| `list-contact-lists` | List the contact lists in the Brevo account | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-contact-lists.ts) |
| `list-contacts-in-list` | List the contacts that belong to a specific contact list | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-contacts-in-list.ts) |
| `list-contacts` | List contacts in the account. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-contacts.ts) |
| `list-deal-pipelines` | List the account's CRM deal pipelines and their stages. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-deal-pipelines.ts) |
| `list-deals` | List deals (Brevo's lightweight CRM deal/opportunity objects). | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-deals.ts) |
| `list-email-campaigns` | List email (classic) campaigns in the account. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-email-campaigns.ts) |
| `list-email-templates` | List the account's transactional email templates. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-email-templates.ts) |
| `list-senders` | List the account's verified sender email addresses. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-senders.ts) |
| `list-sms-campaigns` | List SMS campaigns in the account, with optional status filtering, sorting and pagination. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/list-sms-campaigns.ts) |
| `remove-contacts-from-list` | Remove one or more contacts, identified by email, from a Brevo contact list. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/remove-contacts-from-list.ts) |
| `schedule-email-campaign` | Schedule a draft email campaign to send at a future date/time. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/schedule-email-campaign.ts) |
| `send-email-campaign-now` | Send an existing draft email campaign immediately. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/send-email-campaign-now.ts) |
| `send-immediate-campaign` | Create a classic email campaign and send it immediately to the given contact lists in one call. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/send-immediate-campaign.ts) |
| `send-transactional-email` | Send a one-off transactional email, either with inline HTML or by rendering a saved template with params. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/send-transactional-email.ts) |
| `subscribe-contact-to-list` | Subscribe an email address to a Brevo contact list, creating the contact if it is new or merging onto the existing contact if it already exists. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/subscribe-contact-to-list.ts) |
| `unsubscribe-contact-from-list` | Unsubscribe a contact from a list: removes a single contact, identified by email, from a single list while leaving all other list memberships untouched | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/unsubscribe-contact-from-list.ts) |
| `update-company` | Update a company's attributes. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-company.ts) |
| `update-contact-folder` | Rename a contact folder. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-contact-folder.ts) |
| `update-contact-list` | Rename a contact list or move it to a different folder. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-contact-list.ts) |
| `update-contact` | Update a contact's attributes, list memberships, or blacklist status (partial merge). | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-contact.ts) |
| `update-deal` | Update a deal's attributes (name, amount, custom fields). | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-deal.ts) |
| `update-email-campaign` | Update a draft or not-yet-sent email campaign. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-email-campaign.ts) |
| `update-email-template` | Update a transactional email template in Brevo | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-email-template.ts) |
| `update-sms-campaign` | Update a draft SMS campaign's fields. | [Action](/docs/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/actions/update-sms-campaign.ts) |
| `companies` | Sync Brevo CRM companies, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/companies.ts) |
| `contact-lists` | Fetches all Brevo contact lists (metadata only, not list membership) via full refresh. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/contact-lists.ts) |
| `contacts` | Sync Brevo contacts, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/contacts.ts) |
| `deals` | Sync Brevo CRM deals, incrementally via the modifiedSince filter with a periodic full refresh to detect deletions. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/deals.ts) |
| `email-campaigns` | Full refresh sync of email (classic) campaigns, including their status and delivery statistics. | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/email-campaigns.ts) |
| `email-templates` | Sync transactional email templates from Brevo (full refresh with delete detection) | [Sync](/docs/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/brevo-api-key/syncs/email-templates.ts) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/brevo-api-key.mdx)</Note>

## Useful links

* [Generate an API key in your Brevo account](https://help.brevo.com/hc/en-us/articles/209467485-Create-and-manage-your-API-keys)
* [API documentation](https://developers.brevo.com/reference/getting-started-1)
* [Authentication guide](https://developers.brevo.com/docs/authentication-schemes)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/brevo-api-key.mdx)</Note>

## API gotchas

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/brevo-api-key.mdx)</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.