Brevo (formerly Sendinblue) API Python SDK

Common errors

• ERROR: Command errored out with exit status 1: ... Running setup.py install for sib-api-v3-sdk ... error

  cause This often indicates missing C/C++ compilers or other build tools required by one of the SDK's transitive dependencies (e.g., `cryptography` for `urllib3` if an older system Python is used), or issues with permissions.
  fix Ensure your system has necessary build tools (e.g., `build-essential` on Debian/Ubuntu, Xcode Command Line Tools on macOS) and that your `pip` is up-to-date (`pip install --upgrade pip`). If using a virtual environment, ensure it's active. Sometimes, `pip install --no-binary :all: sib-api-v3-sdk` or installing `wheel` first (`pip install wheel`) can help.

• AttributeError: module 'sib_api_v3_sdk' has no attribute 'TransactionalEmailsApi'

  cause This error occurs when trying to access API client classes or model classes directly from the top-level `sib_api_v3_sdk` module, instead of their correct submodules.
  fix API client classes are usually in `sib_api_v3_sdk.api` and model classes in `sib_api_v3_sdk.model`. For example, use `from sib_api_v3_sdk.api import transactional_emails_api` and `from sib_api_v3_sdk.model.send_smtp_email import SendSmtpEmail`.

• sib_api_v3_sdk.rest.ApiException: (401)
  Reason: Unauthorized
  HTTP response body: {'code': 'unauthorized', 'message': 'Invalid API Key'}

  cause The provided API key is either incorrect, revoked, or has insufficient permissions for the attempted operation.
  fix Verify that your API key is correct and active in your Brevo account. Ensure it has the necessary permissions for the API calls you are making (e.g., Transactional Emails permission for sending emails). Double-check for leading/trailing spaces or typos.

Warnings

• breaking Sendinblue rebranded to Brevo in 2023. While the Python SDK package name `sib-api-v3-sdk` remains the same, documentation, branding, and some concepts now refer to 'Brevo'. This can cause confusion when searching for resources or matching old Sendinblue terminology to new Brevo contexts.
  Fix: Be aware that 'Sendinblue' and 'Brevo' refer to the same service. Prioritize official Brevo documentation and use 'Brevo API' in searches. The SDK code remains functional under the new branding.
• gotcha API keys are sensitive credentials. Hardcoding them directly in your source code is a security risk. Exposure can lead to unauthorized access to your Brevo account.
  Fix: Always store your API key securely, preferably in environment variables (e.g., `os.environ.get('BREVO_API_KEY')`), a secrets management service, or a configuration file that is not committed to version control.
• gotcha The SDK is auto-generated from an OpenAPI specification (Swagger Codegen). This means class structures and method names might not always follow typical Pythonic conventions, which can occasionally lead to unexpected import paths or method signatures.
  Fix: Refer closely to the official documentation and the SDK's source code on GitHub to understand the exact module structure and method definitions. Pay attention to snake_case vs. CamelCase in generated code.

Install

• pip install sib-api-v3-sdk Install with pip

Imports

• sib_api_v3_sdk

  import sib_api_v3_sdk

• Configuration
  wrong:

  import sib_api_v3_sdk.Configuration

  correct:

  from sib_api_v3_sdk import Configuration

  Configuration is a class within the main package, not a submodule.
• TransactionalEmailsApi
  wrong:

  from sib_api_v3_sdk import TransactionalEmailsApi

  correct:

  from sib_api_v3_sdk.api import transactional_emails_api

  API classes are typically found within the `sib_api_v3_sdk.api` submodule, and their names are often snake_case in the import path.
• SendSmtpEmail
  wrong:

  from sib_api_v3_sdk import SendSmtpEmail

  correct:

  from sib_api_v3_sdk.model.send_smtp_email import SendSmtpEmail

  Model classes representing API payloads are usually located in the `sib_api_v3_sdk.model` submodule.

Quickstart

This quickstart demonstrates how to configure the Brevo Python SDK using an API key and send a basic transactional email. Ensure your `BREVO_API_KEY` environment variable is set or replace 'YOUR_API_KEY' with your actual API key.

import sib_api_v3_sdk
from sib_api_v3_sdk.api import transactional_emails_api
from sib_api_v3_sdk.model.send_smtp_email import SendSmtpEmail
import os

# Configure API key authorization: api-key
configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = os.environ.get('BREVO_API_KEY', 'YOUR_API_KEY')

# Create an instance of the API class
api_instance = transactional_emails_api.TransactionalEmailsApi(sib_api_v3_sdk.ApiClient(configuration))

# Define the email to be sent
sender = {"name":"Sender Name", "email":"sender@example.com"}
to = [{"email":"recipient@example.com", "name":"Recipient Name"}]

send_smtp_email = SendSmtpEmail(
    sender=sender,
    to=to,
    subject="My Test Subject",
    html_content="<html><body><h1>This is a test email from Brevo!</h1></body></html>"
)

try:
    # Send a transactional email
    api_response = api_instance.send_transac_email(send_smtp_email)
    print(f"API called successfully. Returned data: {api_response}")
except sib_api_v3_sdk.rest.ApiException as e:
    print(f"Exception when calling TransactionalEmailsApi->send_transac_email: {e}")