Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

The client.domains resource manages your sending domains — useful for multi-tenant apps onboarding customer domains, or for automating DNS verification. For the concepts behind domain setup (SPF, DKIM, DMARC), see Sending Domains.
import lettr

client = lettr.Lettr("lttr_your_api_key")

List Domains

domains = client.domains.list()
for domain in domains:
    print(f"{domain.domain}{domain.status_label}")
    print(domain.can_send, domain.dkim_status, domain.cname_status)

API Reference

GET /domains

Add a Domain

domain = client.domains.create("example.com")
print(domain.status_label)
print(domain.dkim)  # DKIM config to publish in DNS

API Reference

POST /domains

Get Domain Details

domain = client.domains.get("example.com")
print(f"DMARC: {domain.dmarc_status}, SPF: {domain.spf_status}")
print(domain.tracking_domain)
print(domain.dns_provider)

API Reference

GET /domains/

Verify Domain DNS

After publishing the records, trigger a verification check:
verification = client.domains.verify("example.com")
print(f"DKIM: {verification.dkim_status}")
print(f"CNAME: {verification.cname_status}")
print(f"DMARC: {verification.dmarc_status}")
print(f"SPF: {verification.spf_status}")
DNS changes take time to propagate. If verification fails right after publishing, wait a few minutes and retry. See Domain Verification troubleshooting.

API Reference

POST /domains//verify

Delete a Domain

client.domains.delete("example.com")
Deleting a domain stops all sending from it immediately. Emails from a deleted domain fail with a validation error.

API Reference

DELETE /domains/

What’s Next

Sending Domains

DNS setup: SPF, DKIM, DMARC

Webhooks

Receive delivery and engagement events