Python SDK

This guide shows how to use Ozi from Python with the ozi-python SDK package.

Installation

Install from PyPI:

pip install ozi-python

Initialize

from ozi import Ozi, types


# Point the client at Ozi
client = Ozi("us_xxx", url="https://app.getozi.com")

Send an email

EmailCreate is a TypedDict for editor hints; at runtime you pass a regular dict. The client accepts from or from_ (it normalizes from_ to from).

from ozi import Ozi, types

client = Ozi("us_xxx", url="https://app.getozi.com")

payload: types.EmailCreate = {
    "to": "[email protected]",
    "from": "[email protected]",
    "subject": "Welcome",
    "html": "<strong>Hello!</strong>",
    "headers": {"X-Campaign": "welcome"},
}

data, err = client.emails.send(payload)
print(data or err)

Ozi forwards your custom headers to SES. Only the X-Ozi-Email-ID and References headers are managed automatically. Attachments and scheduling:

from datetime import datetime, timedelta

payload: types.EmailCreate = {
    "to": ["[email protected]", "[email protected]"],
    "from": "[email protected]",
    "subject": "Report",
    "text": "See attached.",
    "attachments": [
        {"filename": "report.txt", "content": "SGVsbG8gd29ybGQ="},  # base64
    ],
    "scheduledAt": datetime.utcnow() + timedelta(minutes=10),
}
data, err = client.emails.create(payload)

Batch send

items: list[types.EmailBatchItem] = [
    {"to": "[email protected]", "from": "[email protected]", "subject": "A", "html": "<p>A</p>"},
    {"to": "[email protected]", "from": "[email protected]", "subject": "B", "html": "<p>B</p>"},
]
data, err = client.emails.batch(items)

Retrieve and manage emails

Get an email:

email, err = client.emails.get("email_123")

Update schedule time:

from datetime import datetime, timedelta

update: types.EmailUpdate = {"scheduledAt": datetime.utcnow() + timedelta(hours=1)}
data, err = client.emails.update("email_123", update)

Cancel a scheduled email:

data, err = client.emails.cancel("email_123")

Contacts

All contact operations require a contact book ID (book_id). Create a contact:

create: types.ContactCreate = {
    "email": "[email protected]",
    "firstName": "Jane",
    "properties": {"plan": "pro"},
}
data, err = client.contacts.create("book_123", create)

Get a contact:

contact, err = client.contacts.get("book_123", "contact_456")

Update a contact:

update: types.ContactUpdate = {"subscribed": False}
data, err = client.contacts.update("book_123", "contact_456", update)

Upsert a contact:

upsert: types.ContactUpsert = {
    "email": "[email protected]",
    "firstName": "Jane",
}
data, err = client.contacts.upsert("book_123", "contact_456", upsert)

Delete a contact:

data, err = client.contacts.delete(book_id="book_123", contact_id="contact_456")

Error handling

By default the client raises OziHTTPError for non-2xx responses. To handle errors as return values, pass raise_on_error=False.

from ozi import Ozi, OziHTTPError

# Raises exceptions on errors (default)
client = Ozi("us_xxx", url="https://app.getozi.com")
try:
    data, _ = client.emails.get("email_123")
except OziHTTPError as e:
    print("request failed:", e)

# Returns (None, error) instead of raising
client = Ozi("us_xxx", url="https://app.getozi.com", raise_on_error=False)
data, err = client.emails.get("email_123")
if err:
    print("error:", err)

Getting Started

Guides

Python SDK

Installation

Initialize

Send an email

Batch send

Retrieve and manage emails

Contacts

Error handling

​Installation

​Initialize

​Send an email

​Batch send

​Retrieve and manage emails

​Contacts

​Error handling

Installation

Initialize

Send an email

Batch send

Retrieve and manage emails

Contacts

Error handling