Brevo

Automate Brevo: manage contacts, lists, and email campaigns.

Add a contact to a Brevo list by email.

Parameters

Parameter	Type	Required	Description
`list_id`	string	Yes	The ID of the Brevo list.
`email`	string	Yes	Contact email

Response

{}

Create a Brevo contact and optionally add it to lists.

Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Contact email
`attributes`	object	No	The contact's details to save, such as first name, last name, or phone number.
`list_ids`	array	No	IDs of the lists to add the contact to.
`update_existing`	boolean	No	Set to true to update the contact if one with this email already exists.

Response

{}

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	The content of the email. You can use HTML formatting, such as <b>bold</b> text and links.
`list_ids`	array	Yes	IDs of the contact lists that will receive the campaign.

Response

{}

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. Brevo requires every list to live in a folder. New accounts have a default folder with ID 1.

Response

{}

Fetch a contact by email.

Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Contact email

Response

{}

List contacts from your Brevo account, one page at a time.

Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum results
`offset`	number	No	The number of contacts to skip before starting the list. Use this to see later pages of results.

Response

{
  "results": [
    {}
  ]
}

Send a single transactional email, such as an order confirmation or receipt, with a subject and message body.

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	The content of the email. You can use HTML formatting, such as <b>bold</b> text and links.
`sender_name`	string	No	Sender name

Response

{}

Update a contact's details and which lists they belong to.

Parameters

Parameter	Type	Required	Description
`email`	string	Yes	Contact email
`attributes`	object	No	The contact details to change, such as first name or last name.
`list_ids`	array	No	IDs of the lists to add the contact to.
`unlink_list_ids`	array	No	IDs of the lists to remove the contact from.

Response

{}