Python SDK
boundry-sdk provides the synchronous boundry client for Boundry’s regional API.
bash
pip install boundry-sdkpython
import os
from boundry import Boundry
client = Boundry(api_key=os.environ["BOUNDRY_API_KEY"])
email = client.emails.send({
"from": "hello@example.com",
"to": "person@example.net",
"subject": "Hello from Boundry",
"html": "<strong>Hello</strong>",
})
print(email.id)Complete API surface
Use the ergonomic resources for common workflows and client.api for every generated operation in the canonical regional API. Close long-lived clients during application shutdown. Review the public source for package tests.
| SDK method | What it does | API reference |
|---|---|---|
client.api.list_api_keys(...) | listApiKeys | OpenAPI only |
client.api.create_api_key(...) | createApiKey | OpenAPI only |
client.api.delete_api_key(...) | deleteApiKey | OpenAPI only |
client.api.list_broadcasts(...) | listBroadcasts | OpenAPI only |
client.api.create_broadcast(...) | createBroadcast | OpenAPI only |
client.api.delete_broadcast(...) | deleteBroadcast | OpenAPI only |
client.api.get_broadcast(...) | getBroadcast | OpenAPI only |
client.api.update_broadcast(...) | updateBroadcast | OpenAPI only |
client.api.cancel_broadcast(...) | cancelBroadcast | OpenAPI only |
client.api.list_broadcast_clicked_links(...) | listBroadcastClickedLinks | OpenAPI only |
client.api.get_broadcast_metrics(...) | getBroadcastMetrics | OpenAPI only |
client.api.list_broadcast_recipients(...) | listBroadcastRecipients | OpenAPI only |
client.api.send_broadcast(...) | sendBroadcast | OpenAPI only |
client.api.list_contact_properties(...) | listContactProperties | OpenAPI only |
client.api.create_contact_property(...) | createContactProperty | OpenAPI only |
client.api.delete_contact_property(...) | deleteContactProperty | OpenAPI only |
client.api.get_contact_property(...) | getContactProperty | OpenAPI only |
client.api.update_contact_property(...) | updateContactProperty | OpenAPI only |
client.api.list_contacts(...) | listContacts | OpenAPI only |
client.api.create_contact(...) | createContact | OpenAPI only |
client.api.delete_contact(...) | deleteContact | OpenAPI only |
client.api.get_contact(...) | getContact | OpenAPI only |
client.api.update_contact(...) | updateContact | OpenAPI only |
client.api.list_contact_segments(...) | listContactSegments | OpenAPI only |
client.api.remove_contact_from_segment(...) | removeContactFromSegment | OpenAPI only |
client.api.add_contact_to_segment(...) | addContactToSegment | OpenAPI only |
client.api.get_contact_topics(...) | getContactTopics | OpenAPI only |
client.api.update_contact_topics(...) | updateContactTopics | OpenAPI only |
client.api.list_domains(...) | List domains | View endpoint |
client.api.create_domain(...) | Create a domain | View endpoint |
client.api.delete_domain(...) | deleteDomain | OpenAPI only |
client.api.get_domain(...) | Retrieve a domain | View endpoint |
client.api.update_domain(...) | updateDomain | OpenAPI only |
client.api.verify_domain(...) | Verify a domain | View endpoint |
client.api.create_domain_claim(...) | createDomainClaim | OpenAPI only |
client.api.get_domain_claim(...) | getDomainClaim | OpenAPI only |
client.api.verify_domain_claim(...) | verifyDomainClaim | OpenAPI only |
client.api.list_emails(...) | List emails | View endpoint |
client.api.send_email(...) | Send an email | View endpoint |
client.api.get_email(...) | Retrieve an email | View endpoint |
client.api.update_scheduled_email(...) | updateScheduledEmail | OpenAPI only |
client.api.list_email_attachments(...) | listEmailAttachments | OpenAPI only |
client.api.get_email_attachment(...) | getEmailAttachment | OpenAPI only |
client.api.cancel_email(...) | cancelEmail | OpenAPI only |
client.api.retry_email(...) | retryEmail | OpenAPI only |
client.api.get_email_source(...) | getEmailSource | OpenAPI only |
client.api.send_batch_emails(...) | sendBatchEmails | OpenAPI only |
client.api.get_email_metrics(...) | getEmailMetrics | OpenAPI only |
client.api.list_received_emails(...) | listReceivedEmails | OpenAPI only |
client.api.get_received_email(...) | getReceivedEmail | OpenAPI only |
client.api.list_received_email_attachments(...) | listReceivedEmailAttachments | OpenAPI only |
client.api.get_received_email_attachment(...) | getReceivedEmailAttachment | OpenAPI only |
client.api.get_received_email_source(...) | getReceivedEmailSource | OpenAPI only |
client.api.get_received_email_thread(...) | getReceivedEmailThread | OpenAPI only |
client.api.health(...) | health | OpenAPI only |
client.api.list_logs(...) | listLogs | OpenAPI only |
client.api.get_log(...) | getLog | OpenAPI only |
client.api.authorize_o_auth(...) | authorizeOAuth | OpenAPI only |
client.api.authorize_o_auth_post(...) | authorizeOAuthPost | OpenAPI only |
client.api.list_o_auth_grants(...) | listOAuthGrants | OpenAPI only |
client.api.revoke_o_auth_grant(...) | revokeOAuthGrant | OpenAPI only |
client.api.register_o_auth_client(...) | registerOAuthClient | OpenAPI only |
client.api.revoke_o_auth_token(...) | revokeOAuthToken | OpenAPI only |
client.api.exchange_o_auth_token(...) | exchangeOAuthToken | OpenAPI only |
client.api.list_regions(...) | List live regions and markets accepting demand requests | OpenAPI only |
client.api.request_region(...) | Create or update a regional demand request | OpenAPI only |
client.api.list_segments(...) | listSegments | OpenAPI only |
client.api.create_segment(...) | createSegment | OpenAPI only |
client.api.delete_segment(...) | deleteSegment | OpenAPI only |
client.api.get_segment(...) | getSegment | OpenAPI only |
client.api.list_segment_contacts(...) | listSegmentContacts | OpenAPI only |
client.api.get_segment_metrics(...) | getSegmentMetrics | OpenAPI only |
client.api.list_suppressions(...) | listSuppressions | OpenAPI only |
client.api.create_suppression(...) | createSuppression | OpenAPI only |
client.api.delete_suppression(...) | deleteSuppression | OpenAPI only |
client.api.get_suppression(...) | getSuppression | OpenAPI only |
client.api.delete_batch_suppressions(...) | deleteBatchSuppressions | OpenAPI only |
client.api.create_batch_suppressions(...) | createBatchSuppressions | OpenAPI only |
client.api.list_templates(...) | listTemplates | OpenAPI only |
client.api.create_template(...) | createTemplate | OpenAPI only |
client.api.delete_template(...) | deleteTemplate | OpenAPI only |
client.api.get_template(...) | getTemplate | OpenAPI only |
client.api.update_template(...) | updateTemplate | OpenAPI only |
client.api.duplicate_template(...) | duplicateTemplate | OpenAPI only |
client.api.publish_template(...) | publishTemplate | OpenAPI only |
client.api.list_topics(...) | listTopics | OpenAPI only |
client.api.create_topic(...) | createTopic | OpenAPI only |
client.api.delete_topic(...) | deleteTopic | OpenAPI only |
client.api.get_topic(...) | getTopic | OpenAPI only |
client.api.update_topic(...) | updateTopic | OpenAPI only |
client.api.managed_one_click_unsubscribe(...) | Process an RFC 8058 one-click unsubscribe | OpenAPI only |
client.api.list_project_webhook_events(...) | listProjectWebhookEvents | OpenAPI only |
client.api.list_webhooks(...) | List webhooks | View endpoint |
client.api.create_webhook(...) | Create a webhook | View endpoint |
client.api.delete_webhook(...) | Delete a webhook | View endpoint |
client.api.get_webhook(...) | Retrieve a webhook | View endpoint |
client.api.update_webhook(...) | Update a webhook | View endpoint |
client.api.list_webhook_events(...) | listWebhookEvents | OpenAPI only |
client.api.get_webhook_event(...) | getWebhookEvent | OpenAPI only |
client.api.list_webhook_attempts(...) | listWebhookAttempts | OpenAPI only |
Before you send
Keep BOUNDRY_API_KEY in the environment and send from a domain verified in the same project: an unverified from domain returns 422. See verify a domain, then send email for attachments, idempotency keys and managed unsubscribe, or webhooks to verify delivery event signatures.