Brevo tools
The 12 Brevo operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List contactsGETLists the contacts, newest first by default, optionally narrowed by list, date or attribute. The response has contacts and count; page with limit and offset.
- Get contactGETReturns one contact with its attributes, lists and the campaign statistics of the last 90 days.
- Create contactPOSTCreates a contact. Send email, or the SMS attribute, or ext_id. With updateEnabled set to true, an existing contact with the same identifier is updated instead of failing.
- Update contactPUTUpdates a contact. Only the fields sent change: listIds adds the contact to lists and unlinkListIds removes it from lists.
- List contact listsGETLists the contact lists with their id, name, folderId and unique subscribers. The response has lists and count; page with limit and offset.
- Create contact listPOSTCreates an empty contact list in a folder and returns its id.
- List email campaignsGETLists the email campaigns, newest first by default. The response has campaigns and count; page with limit and offset. Statistics come back only when statistics is sent.
- Get email campaignGETReturns one email campaign with its settings, recipients and report statistics.
- Create email campaignPOSTCreates an email campaign as a draft and returns its id. Send the content in exactly one of htmlContent, htmlUrl or templateId. Setting scheduledAt schedules the sending, and then recipients are required.
- Update email campaignPUTUpdates a draft or scheduled email campaign. Only the fields sent change. Setting scheduledAt schedules the sending.
- Send email campaignPOSTSends an email campaign to its recipients right away. The campaign needs recipients and content, and the sending spends email credits: without enough credits the app answers 402.
- Send transactional emailPOSTSends a transactional email to the addresses in to, right away or at scheduledAt, and returns its messageId. Send sender, subject and htmlContent or textContent, or a templateId, whose sender and subject apply unless sent.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
