Lodol Docs

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

ParameterTypeRequiredDescription
list_idstringYesBrevo list id
emailstringYesContact email

Response

{}

Create contact

Create a Brevo contact and optionally add it to lists.

Parameters

ParameterTypeRequiredDescription
emailstringYesContact email
attributesobjectNoContact attributes
list_idsarrayNoList ids to add contact to
update_existingbooleanNoUpdate existing contact

Response

{}

Create email campaign

Create an email campaign targeting specific lists.

Parameters

ParameterTypeRequiredDescription
sender_namestringYesSender name
sender_emailstringYesSender email
subjectstringYesCampaign subject
html_contentstringYesHTML content
list_idsarrayYesTarget list ids

Response

{}

Create contact list

Create a new Brevo contact list.

Parameters

ParameterTypeRequiredDescription
namestringYesList name
folder_idnumberYesID of the folder to create the list in

Response

{}

Get contact

Fetch a contact by email.

Parameters

ParameterTypeRequiredDescription
emailstringYesContact email

Response

{}

List contacts

List contacts with pagination.

Parameters

ParameterTypeRequiredDescription
limitnumberNoMaximum results
offsetnumberNoPagination offset

Response

{
  "results": [
    {}
  ]
}

Send transactional email

Send a single transactional email with subject and HTML content.

Parameters

ParameterTypeRequiredDescription
sender_emailstringYesSender email
to_emailstringYesRecipient email
subjectstringYesEmail subject
html_contentstringYesHTML content
sender_namestringNoSender name

Response

{}

Update contact

Update contact attributes and list memberships.

Parameters

ParameterTypeRequiredDescription
emailstringYesContact email
attributesobjectNoAttributes to update
list_idsarrayNoList ids to add
unlink_list_idsarrayNoList ids to remove

Response

{}

On this page