> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/brevo.md).

# Brevo

Brevo (formerly Sendinblue) for transactional email and SMS, contact and list management, and email campaigns.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Brevo     | API Key        |

#### Brevo

Connect to Brevo (formerly Sendinblue) with an API key to send transactional email and SMS, manage contacts and lists, and send campaigns.

**Set up in Brevo**

1. Prepare the Brevo account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Brevo API key, from SMTP & API > API keys at app.brevo.com. The key is sent in the api-key request header.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Brevo**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                     |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Brevo API key, from SMTP & API > API keys at app.brevo.com. The key is sent in the api-key request header. [Provider instructions](https://app.brevo.com/settings/keys/api). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Brevo** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create or Update Contact

Create a Brevo contact, or update it if the email already exists.

**Inputs**

| Field             | Type     | Required | Description                                                      |
| ----------------- | -------- | -------- | ---------------------------------------------------------------- |
| Contact Email     | string   | Yes      | Email address of the contact to create or update.                |
| Attributes (JSON) | textarea | No       | Contact attributes as a JSON object (keys must exist in Brevo).  |
| List IDs          | string   | No       | Comma-separated Brevo list IDs to add the contact to.            |
| Update If Exists  | boolean  | No       | Update the contact when the email already exists. Default: true. |
| Email Blacklisted | boolean  | No       | Blacklist the contact for emails.                                |
| SMS Blacklisted   | boolean  | No       | Blacklist the contact for SMS.                                   |

**Outputs**

| Field          | Type    | Description                                              |
| -------------- | ------- | -------------------------------------------------------- |
| Contact ID     | string  | Numeric ID of the contact.                               |
| Email          | string  | Email address of the contact.                            |
| Created        | boolean | Whether the contact was newly created (false = updated). |
| Contact        | object  | The full contact object when available.                  |
| Result Message | string  | Human-readable result summary.                           |

#### Send Transactional Email

Send a transactional email via Brevo (inline content or template).

**Inputs**

| Field                  | Type     | Required | Description                                      |
| ---------------------- | -------- | -------- | ------------------------------------------------ |
| To                     | string   | Yes      | Recipient email address(es), comma-separated.    |
| Subject                | string   | No       | Subject line (required unless using a template). |
| Sender Email           | string   | Yes      | Verified sender email address.                   |
| Sender Name            | string   | No       | Display name shown as the sender.                |
| HTML Content           | textarea | No       | HTML body of the email.                          |
| Text Content           | textarea | No       | Plain-text body of the email.                    |
| Template ID            | integer  | No       | Brevo transactional template ID.                 |
| Template Params (JSON) | textarea | No       | Template placeholder values as a JSON object.    |
| Cc                     | string   | No       | Cc email address(es), comma-separated.           |
| Bcc                    | string   | No       | Bcc email address(es), comma-separated.          |
| Reply-To               | string   | No       | Reply-to email address.                          |

**Outputs**

| Field          | Type          | Description                                  |
| -------------- | ------------- | -------------------------------------------- |
| Message ID     | string        | Brevo message ID for the sent email.         |
| Message IDs    | string\_array | All message IDs when multiple were returned. |
| Result Message | string        | Human-readable result summary.               |

#### Send Transactional SMS

Send a transactional (or marketing) SMS via Brevo.

**Inputs**

| Field                  | Type            | Required | Description                                                                                         |
| ---------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------- |
| Recipient              | string          | Yes      | Mobile number with country code.                                                                    |
| Sender                 | string          | Yes      | Sender name (max 11 alphanumeric or 15 numeric characters).                                         |
| Content                | textarea        | No       | SMS message body (required unless using a template).                                                |
| Template ID            | integer         | No       | Brevo SMS template ID.                                                                              |
| Template Params (JSON) | textarea        | No       | Template placeholder values as a JSON object.                                                       |
| SMS Type               | select (string) | No       | Transactional or marketing SMS. Available values: Transactional, Marketing. Default: transactional. |
| Tag                    | string          | No       | Optional tag for reporting.                                                                         |

**Outputs**

| Field             | Type    | Description                           |
| ----------------- | ------- | ------------------------------------- |
| Message ID        | string  | Brevo message ID for the sent SMS.    |
| Reference         | string  | Brevo reference for the SMS.          |
| SMS Count         | integer | Number of SMS segments used.          |
| Remaining Credits | string  | Remaining SMS credits after the send. |
| Result Message    | string  | Human-readable result summary.        |

#### Add Contact to List

Add one or more contacts to a Brevo contact list by email.

**Inputs**

| Field        | Type            | Required | Description                                                                                  |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Contact List | select (string) | Yes      | Select a contact list, or type a numeric list ID. Options load from the selected connection. |
| Emails       | string          | Yes      | Contact email address(es) to add, comma-separated.                                           |

**Outputs**

| Field          | Type    | Description                          |
| -------------- | ------- | ------------------------------------ |
| List ID        | string  | Numeric ID of the contact list.      |
| Success Count  | integer | Number of emails successfully added. |
| Failure Count  | integer | Number of emails that failed to add. |
| Raw Response   | dict    | Full Brevo response body.            |
| Result Message | string  | Human-readable result summary.       |

#### Send Campaign

Create a Brevo email campaign and send it now, or send an existing draft by campaign ID.

**Inputs**

| Field                | Type            | Required | Description                                                                                   |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Existing Campaign ID | integer         | No       | Send an existing draft campaign by ID (skips create).                                         |
| Campaign Name        | string          | No       | Name of the campaign to create.                                                               |
| Subject              | string          | No       | Email subject line.                                                                           |
| Sender Email         | string          | No       | Verified sender email for the campaign.                                                       |
| Sender Name          | string          | No       | Sender display name.                                                                          |
| HTML Content         | textarea        | No       | HTML body (required unless using template\_id or html\_url).                                  |
| HTML URL             | string          | No       | URL of hosted HTML content.                                                                   |
| Template ID          | integer         | No       | Brevo campaign template ID.                                                                   |
| Recipient List IDs   | select (string) | No       | Comma-separated list IDs to include as recipients. Options load from the selected connection. |
| Reply-To             | string          | No       | Reply-to email address.                                                                       |
| Preview Text         | string          | No       | Email preview / preheader text.                                                               |
| Send Immediately     | boolean         | No       | Send the campaign immediately after creating it. Default: true.                               |
| Campaign Type        | select (string) | No       | Classic or trigger campaign. Available values: Classic, Trigger. Default: classic.            |

**Outputs**

| Field          | Type    | Description                         |
| -------------- | ------- | ----------------------------------- |
| Campaign ID    | string  | Numeric ID of the campaign.         |
| Created        | boolean | Whether a new campaign was created. |
| Sent           | boolean | Whether sendNow was called.         |
| Result Message | string  | Human-readable result summary.      |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/brevo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
