Brevo
API actions for the Brevo integration.
Brevo
Automate Brevo: manage contacts, lists, and campaigns with API keys.
Add contact to list
Add a contact to a Brevo list by email.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_id | string | Yes | Brevo list id |
email | string | Yes | Contact email |
Response
{}Create contact
Create a Brevo contact and optionally add it to lists.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Contact email |
attributes | object | No | Contact attributes |
list_ids | array | No | List ids to add contact to |
update_existing | boolean | No | Update existing contact |
Response
{}Create email campaign
Create an email campaign targeting specific lists.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sender_name | string | Yes | Sender name |
sender_email | string | Yes | Sender email |
subject | string | Yes | Campaign subject |
html_content | string | Yes | HTML content |
list_ids | array | Yes | Target list ids |
Response
{}Create contact list
Create a new Brevo contact list.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | List name |
folder_id | number | Yes | ID of the folder to create the list in |
Response
{}Get contact
Fetch a contact by email.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Contact email |
Response
{}List contacts
List contacts with pagination.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | No | Maximum results |
offset | number | No | Pagination offset |
Response
{
"results": [
{}
]
}Send transactional email
Send a single transactional email with subject and HTML content.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sender_email | string | Yes | Sender email |
to_email | string | Yes | Recipient email |
subject | string | Yes | Email subject |
html_content | string | Yes | HTML content |
sender_name | string | No | Sender name |
Response
{}Update contact
Update contact attributes and list memberships.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Contact email |
attributes | object | No | Attributes to update |
list_ids | array | No | List ids to add |
unlink_list_ids | array | No | List ids to remove |
Response
{}