Brevo
Send transactional emails and manage contacts with Brevo
Integrate Brevo (formerly Sendinblue) into your workflow. Send transactional emails and SMS, manage contact lists for EU-compliant marketing, use pre-built templates, retrieve campaign analytics, and handle GDPR-compliant contact management.
Retrieve contacts from Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
limit | number | No | Number of contacts to return (max 1000) |
offset | number | No | Number of contacts to skip for pagination |
modifiedSince | string | No | Filter contacts modified after this ISO 8601 date |
sort | string | No | Sort direction: "asc" or "desc" |
| Parameter | Type | Description |
|---|
contacts | json | Array of Brevo contact objects |
count | number | Total number of contacts |
Create a new contact in Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
email | string | No | Contact email address |
firstName | string | No | Contact first name (stored in FIRSTNAME attribute) |
lastName | string | No | Contact last name (stored in LASTNAME attribute) |
phone | string | No | Contact phone number (stored in SMS attribute) |
listIds | string | No | Comma-separated list IDs to subscribe the contact to |
attributes | json | No | Additional contact attributes as JSON object |
updateEnabled | boolean | No | If true, update existing contact instead of failing on duplicate |
| Parameter | Type | Description |
|---|
id | number | Brevo contact ID |
email | string | Contact email address |
Update an existing contact in Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
identifier | string | No | Contact email address or ID to update |
firstName | string | No | Updated first name |
lastName | string | No | Updated last name |
phone | string | No | Updated phone number |
listIds | string | No | Comma-separated list IDs to subscribe the contact to |
attributes | json | No | Updated contact attributes as JSON object |
emailBlacklisted | boolean | No | Set to true to unsubscribe the contact from email marketing |
| Parameter | Type | Description |
|---|
success | boolean | Whether the contact was updated successfully |
identifier | string | Contact identifier (email or ID) |
Send a transactional email via Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
toEmail | string | No | Recipient email address |
toName | string | No | Recipient name |
fromEmail | string | No | Sender email address (must be verified in Brevo) |
fromName | string | No | Sender name |
subject | string | No | Email subject line |
htmlContent | string | No | HTML content of the email body |
textContent | string | No | Plain text content of the email body |
templateId | number | No | Brevo template ID to use instead of inline content |
cc | string | No | CC email addresses (comma-separated) |
bcc | string | No | BCC email addresses (comma-separated) |
| Parameter | Type | Description |
|---|
success | boolean | Whether the email was sent successfully |
messageId | string | Brevo message ID |
toEmail | string | Recipient email address |
subject | string | Email subject |
Retrieve email campaigns from Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
type | string | No | Campaign type filter: "classic" or "trigger" |
status | string | No | Campaign status filter: "draft", "sent", "archive", "queued", "suspended", "inProcess" |
limit | number | No | Number of campaigns to return (max 500) |
offset | number | No | Number of campaigns to skip for pagination |
| Parameter | Type | Description |
|---|
campaigns | json | Array of Brevo email campaign objects |
count | number | Total number of campaigns |
Retrieve email templates from Brevo (formerly Sendinblue)
| Parameter | Type | Required | Description |
|---|
apiKey | string | No | Brevo API key |
templateStatus | boolean | No | Filter by active status (true = active, false = inactive) |
limit | number | No | Number of templates to return (max 500) |
offset | number | No | Number of templates to skip for pagination |
| Parameter | Type | Description |
|---|
templates | json | Array of Brevo email template objects |
count | number | Total number of templates |