| name | listmonk |
| description | Listmonk Email API Client for Python. Use when writing Python code that uses the listmonk package.
|
| license | MIT |
| compatibility | Requires Python >=3.10. |
Listmonk
Listmonk Email API Client for Python
Installation
pip install listmonk
API overview
Configuration & Authentication
Point the client at your Listmonk instance and authenticate.
set_url_base: Set the base URL of your Listmonk instance for all subsequent callsget_base_url: Return the configured base URL of your Listmonk instancelogin: Log into Listmonk and cache the credentials for the life of your appverify_login: Verify that the stored login credentials are still valid at the serveris_healthy: Check whether the server is reachable and the stored credentials are valid
Mailing Lists
Read and manage mailing lists.
lists: Get all mailing lists on the serverlist_by_id: Get the full details of a single mailing list by its IDcreate_list: Create a new mailing list on the serverupdate_list: Update an existing mailing list on the serverdelete_list: Delete a mailing list by its ID
Subscribers
Create, query, update, and manage the status of subscribers.
subscribers: Get the list of subscribers matching the given criteria, or all subscribers if no criteria are givensubscriber_by_email: Retrieve a single subscriber by their email address (e.g. "some_user@talkpython.fm")subscriber_by_id: Retrieve a single subscriber by their numeric Listmonk ID (e.g. 201)subscriber_by_uuid: Retrieve a single subscriber by their UUID (e.g. "c37786af-e6ab-4260-9b49-740adpcm6ed")create_subscriber: Create a new subscriber on the Listmonk serverupdate_subscriber: Update many aspects of a subscriber: email and name, custom attribute data, list membership, and statusadd_subscribers_to_lists: Add a number of subscribers to a number of lists in a single bulk operationenable_subscriber: Set a subscriber's status to enabled so they will receive campaignsdisable_subscriber: Set a subscriber's status to disabled, pausing their subscription so they will not receive campaignsblock_subscriber: Add a subscriber to the blocklist, effectively unsubscribing them so they will not receive any mailconfirm_optin: Confirm a subscriber's opt-in to a list via the APIdelete_subscriber: Completely delete a subscriber from your system (as if they were never there)
Campaigns
Create, preview, update, and delete email campaigns.
campaigns: Get all campaigns on the servercampaign_by_id: Get the full details of a campaign with the given IDcampaign_preview_by_id: Get the rendered preview of a campaign with the given IDcreate_campaign: Create a new campaign with the given parametersupdate_campaign: Update an existing campaign with the provided campaign informationdelete_campaign: Completely delete a campaign from your system
Media
Upload files to the media library to attach to campaigns.
upload_media: Upload a file to the Listmonk media library
Templates
Manage email templates and set the default.
templates: Retrieve all templates defined on the Listmonk instancetemplate_by_id: Retrieve a single template by its numeric IDtemplate_preview_by_id: Render and return a preview of a templatecreate_template: Create a new template on the Listmonk instanceupdate_template: Update an existing template on the Listmonk instanceset_default_template: Mark the given template as the default for its typedelete_template: Permanently delete a template from the Listmonk instance
Transactional Email
Send one-off transactional messages.
send_transactional_email: Send a transactional email through Listmonk to a single recipient
Data Models
Pydantic models returned by and passed to the API functions.
models.MailingListmodels.SubscriberStatusmodels.SubscriberStatusesmodels.Subscribermodels.CreateSubscriberModelmodels.Campaignmodels.CreateCampaignModelmodels.UpdateCampaignModelmodels.CampaignPreviewmodels.Templatemodels.CreateTemplateModelmodels.TemplatePreviewmodels.Media
Exceptions
Errors raised by the client.
errors.ValidationErrorerrors.OperationNotAllowedErrorerrors.ListmonkFileNotFoundError
Resources
