Table of Contents
Take your business to new heights with the complete all-in-one digital marketing toolbox that's built to scale and adapt with you as you grow.
API Overview
Brevo (formerly SendinBlue) is a comprehensive email marketing and customer relationship management (CRM) platform designed to empower businesses of all sizes. It offers a wide range of features, including email marketing automation, SMS marketing, transactional emails, CRM, live chat, and marketing automation. With Brevo, users can create and send personalized email campaigns, track email performance, manage customer relationships, and automate marketing workflows. Its user-friendly interface, robust functionality, and affordable pricing make it an ideal solution for businesses looking to streamline their marketing and sales efforts.
Brevo (formerly SendinBlue) API provides a comprehensive set of RESTful APIs that allow developers to integrate Brevo's functionality into their own applications. The API documentation is extensive and well-organized, providing detailed information on all API endpoints, parameters, and response formats. The REST APIs cover all aspects of Brevo's functionality, including email marketing, SMS marketing, CRM, and marketing automation. Additionally, Brevo offers webhooks that allow developers to receive real-time notifications of events within their Brevo account. The API also includes rate limits to ensure the platform's stability and performance. By leveraging Brevo's API, developers can extend the platform's capabilities and create custom solutions tailored to their specific business needs.
API Request Limits
Free (up to 300 emails/day)
Unlimited API requests
Lite (up to 100,000 emails/month)
100,000 requests per day
Premium (up to 1 million emails/month)
1 million requests per day
Enterprise (custom)
Negotiated rate limits
APIs
Method: GET
Description: Get all the campaigns..
Endpoint: /v3/campaigns
Parameters: {id}
Method: POST
Description: Create a campaign..
Endpoint: /v3/campaigns
Parameters: campaignName, subject, sender.name, sender.email, replyTo, htmlContent, textContent, plannedSend, sendNow, scheduledAt, attachmentUrl, inlineImageActivation, mirrorActive, autoWarmup, subjectA, subjectB, subjectC, replyToA, replyToB, replyToC, fromNameA, fromNameB, fromNameC, fromEmailA, fromEmailB, fromEmailC, messageId, tag, segment, requestInjectionApiKey
Method: GET
Description: Get detailed info about a campaign..
Endpoint: /v3/campaigns/{campaignId}
Parameters: campaignId
Method: PUT
Description: Update some fields in a campaign..
Endpoint: /v3/campaigns/{campaignId}
Parameters: campaignId, templateId, sender.name, sender.email, replyTo, htmlContent, textContent, subject, plannedSend, sendNow, attachmentUrl, inlineImageActivation, mirrorActive, autoWarmup, segment, requestInjectionApiKey
Method: DELETE
Description: Delete a campaign..
Endpoint: /v3/campaigns/{campaignId}
Parameters: campaignId
Method: POST
Description: Send a text message to a contact or a list of contacts..
Endpoint: /v3/transactionalSMS/sms
Parameters: sender, recipient, content, options, tag, webURL, campaignName
Method: GET
Description: Get all the lists..
Endpoint: /v3/lists/{listId}
Parameters: listId
Method: POST
Description: Create a new list..
Endpoint: /v3/lists
Parameters: listName
Method: GET
Description: Get detailed info. about a list..
Endpoint: /v3/lists/{listId}
Parameters: listId
Method: PUT
Description: Update some fields in a list..
Endpoint: /v3/lists/{listId}
Parameters: listId, listName
Method: DELETE
Description: Delete a list..
Endpoint: /v3/lists/{listId}
Parameters: listId
Method: GET
Description: Get all the contacts..
Endpoint: /v3/contacts
Parameters: filter, limit, offset, sort, attributes, selectAttributes
Method: POST
Description: Create a new contact or update an existing one..
Endpoint: /v3/contacts
Parameters: email, attributes, emailBlacklisted, smsBlacklisted, listIds, updateEnabled
Method: GET
Description: Get detailed info. about a contact..
Endpoint: /v3/contacts/{contactId}
Parameters: contactId
Method: PUT
Description: Update some fields in a contact..
Endpoint: /v3/contacts/{contactId}
Parameters: contactId, email, attributes, emailBlacklisted, smsBlacklisted, listIds, updateEnabled
Method: DELETE
Description: Delete a contact..
Endpoint: /v3/contacts/{contactId}
Parameters: contactId
Method: GET
Description: Get all the folders..
Endpoint: /v3/folders
Parameters: limit, offset, sort
Method: POST
Description: Create a new folder..
Endpoint: /v3/folders
Parameters: name, color
Method: DELETE
Description: Delete a folder..
Endpoint: /v3/folders/{folderId}
Parameters: folderId
Method: GET
Description: Get all attributes..
Endpoint: /v3/attributes
Parameters: limit, offset
Method: POST
Description: Create a new attribute..
Endpoint: /v3/attributes
Parameters: name, type
Method: GET
Description: Get detailed info. about an attribute..
Endpoint: /v3/attributes/{attributeId}
Parameters: attributeId
Method: PUT
Description: Update an attribute..
Endpoint: /v3/attributes/{attributeId}
Parameters: attributeId, name, type
Method: DELETE
Description: Delete an attribute..
Endpoint: /v3/attributes/{attributeId}
Parameters: attributeId
Method: POST
Description: Send an email to a list of contacts..
Endpoint: /v3/smtp/email
Parameters: sender, to, cc, bcc, htmlContent, subject, replyTo, attachmentUrl, headers, inlineImageActivation, params, templateId, tag, scheduledAt, requestInjectionApiKey
FAQ
How do I authenticate to the Sendinblue API?
You can authenticate using an API key, which you can obtain from the Sendinblue dashboard. Set the Authorization header of your API calls to 'Bearer [API key]'.
What are the rate limits for the Sendinblue API?
The API has rate limits to ensure fair usage and prevent abuse. The specific limits depend on the endpoint and your subscription plan. You can check the rate limits in the API documentation.
Can I create a sandbox account for testing?
Yes, you can create a sandbox account to test the API without affecting your live data. Sandbox accounts are isolated from production accounts and use fake data.
How can I access a developer account?
You can apply for a developer account on the Sendinblue website. Developer accounts provide access to additional features and support.
What is the difference between a contact list and a segment?
A contact list is a static list of email addresses. A segment is a dynamic list that is created based on specific criteria, such as demographics or behavior.