Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

Отправка email

Отправляйте отдельные транзакционные email с помощью эндпоинта /v3/smtp/email.

Эндпоинт

POST /v3/smtp/email

Тело запроса

Базовое письмо

{
"sender": {
"name": "Your App",
"email": "[email protected]"
},
"to": [
{
"email": "[email protected]",
"name": "John Doe"
}
],
"subject": "Welcome to our service!",
"htmlContent": "<html><body><h1>Welcome!</h1><p>Thank you for signing up.</p></body></html>"
}

Расширенное письмо

{
"sender": {
"name": "Your App",
"email": "[email protected]"
},
"to": [
{
"email": "[email protected]",
"name": "John Doe"
}
],
"cc": [
{
"email": "[email protected]",
"name": "CC User"
}
],
"bcc": [
{
"email": "[email protected]"
}
],
"subject": "Order Confirmation #{{order_id}}",
"htmlContent": "<html><body><h1>Order Confirmed</h1><p>Your order {{order_id}} has been confirmed.</p></body></html>",
"textContent": "Your order {{order_id}} has been confirmed.",
"params": {
"order_id": "12345"
},
"tags": ["transactional", "order-confirmation"],
"headers": {
"X-Custom-Header": "custom-value"
}
}

Примеры кода

JavaScript/Node.js

const brevo = require('@getbrevo/brevo');
const apiInstance = new brevo.TransactionalEmailsApi();
apiInstance.setApiKey(brevo.TransactionalEmailsApiApiKeys.apiKey, process.env.BREVO_API_KEY);
const sendEmail = async () => {
const sendSmtpEmail = new brevo.SendSmtpEmail();
sendSmtpEmail.subject = "Welcome to our service!";
sendSmtpEmail.htmlContent = "<html><body><h1>Welcome!</h1></body></html>";
sendSmtpEmail.sender = { name: "Your App", email: "[email protected]" };
sendSmtpEmail.to = [{ email: "[email protected]", name: "John Doe" }];
try {
const result = await apiInstance.sendTransacEmail(sendSmtpEmail);
console.log('Email sent:', result);
return result;
} catch (error) {
console.error('Error sending email:', error);
throw error;
}
};

Python

import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
api_instance = sib_api_v3_sdk.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))
send_smtp_email = sib_api_v3_sdk.SendSmtpEmail(
to=[{"email": "[email protected]", "name": "John Doe"}],
sender={"name": "Your App", "email": "[email protected]"},
subject="Welcome to our service!",
html_content="<html><body><h1>Welcome!</h1></body></html>"
)
try:
api_response = api_instance.send_transac_email(send_smtp_email)
print(api_response)
except ApiException as e:
print("Exception when calling TransactionalEmailsApi->send_transac_email: %s\n" % e)

cURL

Terminal window
curl -X POST "https://api.brevo.com/v3/smtp/email" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "api-key: YOUR_API_KEY" \
-d '{
"sender": {
"name": "Your App",
"email": "[email protected]"
},
"to": [
{
"email": "[email protected]",
"name": "John Doe"
}
],
"subject": "Welcome to our service!",
"htmlContent": "<html><body><h1>Welcome!</h1></body></html>"
}'

Ответ

Успешный ответ (201 Created)

{
"messageId": "<[email protected]>"
}

Ответы с ошибками

Недействительный ключ API (401)

{
"code": "unauthorized",
"message": "Invalid API key provided"
}

Недопустимый формат email (400)

{
"code": "invalid_parameter",
"message": "Invalid email format in 'to' field"
}

Превышен лимит частоты запросов (429)

{
"code": "too_many_requests",
"message": "Rate limit exceeded"
}

Параметры

Обязательные параметры

ПараметрТипОписание
senderobjectИнформация об отправителе
toarrayМассив объектов получателей
subjectstringТема письма

Необязательные параметры

ПараметрТипОписание
htmlContentstringHTML-содержимое письма
textContentstringТекстовое содержимое письма
ccarrayПолучатели копии
bccarrayПолучатели скрытой копии
replyToobjectАдрес для ответа
attachmentsarrayВложенные файлы
paramsobjectПараметры шаблона
tagsarrayТеги письма для отслеживания
headersobjectПользовательские заголовки

Переменные шаблона

Используйте переменные шаблона в теме и содержимом письма:

{
"subject": "Welcome {{firstName}}!",
"htmlContent": "<h1>Hello {{firstName}} {{lastName}}</h1>",
"params": {
"firstName": "John",
"lastName": "Doe"
}
}

Вложения

Добавляйте вложенные файлы:

{
"attachments": [
{
"content": "base64_encoded_content",
"name": "invoice.pdf"
},
{
"url": "https://example.com/document.pdf",
"name": "document.pdf"
}
]
}

Рекомендации

  1. Всегда включайте и HTML, и текстовое содержимое для лучшей доставляемости
  2. Используйте переменные шаблона вместо склеивания содержимого
  3. Указывайте корректную информацию об отправителе, чтобы не попасть в спам-фильтры
  4. Добавляйте теги для отслеживания и аналитики
  5. Проверяйте адреса email перед отправкой
  6. Аккуратно обрабатывайте ошибки с логикой повторных попыток

Лимиты частоты запросов

  • Бесплатные аккаунты: 300 писем в день
  • Платные аккаунты: в зависимости от вашего тарифа
  • Пиковый лимит: 100 писем в минуту

Отслеживание

Письма, отправленные через этот эндпоинт, автоматически отслеживаются по следующим параметрам:

  • Статус доставки
  • Процент открытий
  • Отслеживание кликов
  • Обработка возвратов

Подробную аналитику смотрите в панели управления Brevo в разделе StatisticsTransactional.

Связанные эндпоинты

Подайте заявку на ранний доступ

Укажите имя, а также email или номер телефона. Мы отправим Вам информацию о доступе к Tajo.

определим автоматически
AI-ассистент

Привет! Спрашивайте меня о документации.