# listmonk unofficial

> listmonk unofficial API documentation

## API Reference › Admin
- [POST /admin/reload](https://octri-zj36wftkny47.octri.dev/post-admin-reload): Restart the application

## API Reference › Bounces
- [GET /bounces](https://octri-zj36wftkny47.octri.dev/get-bounces): List bounce records
- [DELETE /bounces](https://octri-zj36wftkny47.octri.dev/delete-bounces): Delete bounce records
- [GET /bounces/{id}](https://octri-zj36wftkny47.octri.dev/get-bounces-id): Get a bounce record
- [DELETE /bounces/{id}](https://octri-zj36wftkny47.octri.dev/delete-bounces-id): Delete a bounce

## API Reference › Campaigns
- [GET /campaigns](https://octri-zj36wftkny47.octri.dev/get-campaigns): List campaigns
- [POST /campaigns](https://octri-zj36wftkny47.octri.dev/post-campaigns): Create a campaign
- [GET /campaigns/{id}](https://octri-zj36wftkny47.octri.dev/get-campaigns-id): Get a campaign by ID
- [PUT /campaigns/{id}](https://octri-zj36wftkny47.octri.dev/put-campaigns-id): Replace a campaign
- [DELETE /campaigns/{id}](https://octri-zj36wftkny47.octri.dev/delete-campaigns-id): Delete a campaign
- [PUT /campaigns/{id}/archive](https://octri-zj36wftkny47.octri.dev/put-campaigns-id-archive): Replace campaign archive settings
- [POST /campaigns/{id}/content](https://octri-zj36wftkny47.octri.dev/post-campaigns-id-content): Submit campaign content
- [GET /campaigns/{id}/preview](https://octri-zj36wftkny47.octri.dev/get-campaigns-id-preview): Get a campaign HTML preview
- [POST /campaigns/{id}/preview](https://octri-zj36wftkny47.octri.dev/post-campaigns-id-preview): Render a campaign HTML preview
- [PUT /campaigns/{id}/status](https://octri-zj36wftkny47.octri.dev/put-campaigns-id-status): Replace a campaign status
- [POST /campaigns/{id}/test](https://octri-zj36wftkny47.octri.dev/post-campaigns-id-test): Send a test campaign message
- [POST /campaigns/{id}/text](https://octri-zj36wftkny47.octri.dev/post-campaigns-id-text): Render a campaign text preview
- [GET /campaigns/analytics/{type}](https://octri-zj36wftkny47.octri.dev/get-campaigns-analytics-type): Get campaign analytics
- [GET /campaigns/running/stats](https://octri-zj36wftkny47.octri.dev/get-campaigns-running-stats): List running campaign statistics

## API Reference › Config
- [GET /config](https://octri-zj36wftkny47.octri.dev/get-config): Get the server configuration

## API Reference › Dashboard
- [GET /dashboard/charts](https://octri-zj36wftkny47.octri.dev/get-dashboard-charts): Get dashboard chart data
- [GET /dashboard/counts](https://octri-zj36wftkny47.octri.dev/get-dashboard-counts): Get dashboard statistics counts

## API Reference › Health
- [GET /health](https://octri-zj36wftkny47.octri.dev/get-health): Get the service health-check result

## API Reference › Import
- [GET /import/subscribers](https://octri-zj36wftkny47.octri.dev/get-import-subscribers): Get subscriber import status
- [POST /import/subscribers](https://octri-zj36wftkny47.octri.dev/post-import-subscribers): Import subscribers from a ZIP file
- [DELETE /import/subscribers](https://octri-zj36wftkny47.octri.dev/delete-import-subscribers): Stop subscriber import
- [GET /import/subscribers/logs](https://octri-zj36wftkny47.octri.dev/get-import-subscribers-logs): Get subscriber import logs

## API Reference › Lang
- [GET /lang/{lang}](https://octri-zj36wftkny47.octri.dev/get-lang-lang): Get a language pack

## API Reference › Lists
- [GET /lists](https://octri-zj36wftkny47.octri.dev/get-lists): List mailing lists
- [POST /lists](https://octri-zj36wftkny47.octri.dev/post-lists): Create a mailing list
- [GET /lists/{list_id}](https://octri-zj36wftkny47.octri.dev/get-lists-list_id): Get a mailing list
- [PUT /lists/{list_id}](https://octri-zj36wftkny47.octri.dev/put-lists-list_id): Replace mailing list details
- [DELETE /lists/{list_id}](https://octri-zj36wftkny47.octri.dev/delete-lists-list_id): Delete a mailing list

## API Reference › Logs
- [GET /logs](https://octri-zj36wftkny47.octri.dev/get-logs): List buffered log entries

## API Reference › Maintenance
- [DELETE /maintenance/analytics/{type}](https://octri-zj36wftkny47.octri.dev/delete-maintenance-analytics-type): Delete campaign analytics by type
- [DELETE /maintenance/subscribers/{type}](https://octri-zj36wftkny47.octri.dev/delete-maintenance-subscribers-type): Delete orphaned or blocklisted subscribers
- [DELETE /maintenance/subscriptions/unconfirmed](https://octri-zj36wftkny47.octri.dev/delete-maintenance-subscriptions-unconfirmed): Delete unconfirmed subscriptions

## API Reference › Media
- [GET /media](https://octri-zj36wftkny47.octri.dev/get-media): List uploaded media
- [POST /media](https://octri-zj36wftkny47.octri.dev/post-media): Upload a media file
- [GET /media/{id}](https://octri-zj36wftkny47.octri.dev/get-media-id): Get an uploaded media record
- [DELETE /media/{id}](https://octri-zj36wftkny47.octri.dev/delete-media-id): Delete an uploaded media record

## API Reference › Public
- [GET /public/lists](https://octri-zj36wftkny47.octri.dev/get-public-lists): List public lists
- [POST /public/subscription](https://octri-zj36wftkny47.octri.dev/post-public-subscription): Submit a public subscription request

## API Reference › Settings
- [GET /settings](https://octri-zj36wftkny47.octri.dev/get-settings): Get server settings
- [PUT /settings](https://octri-zj36wftkny47.octri.dev/put-settings): Update server settings
- [POST /settings/smtp/test](https://octri-zj36wftkny47.octri.dev/post-settings-smtp-test): Test SMTP settings

## API Reference › Subscribers
- [GET /subscribers](https://octri-zj36wftkny47.octri.dev/get-subscribers): List subscribers
- [POST /subscribers](https://octri-zj36wftkny47.octri.dev/post-subscribers): Create a subscriber
- [DELETE /subscribers](https://octri-zj36wftkny47.octri.dev/delete-subscribers): Delete subscribers by ID
- [GET /subscribers/{id}](https://octri-zj36wftkny47.octri.dev/get-subscribers-id): Get a subscriber by ID
- [PUT /subscribers/{id}](https://octri-zj36wftkny47.octri.dev/put-subscribers-id): Replace subscriber data
- [DELETE /subscribers/{id}](https://octri-zj36wftkny47.octri.dev/delete-subscribers-id): Delete a subscriber by ID
- [PUT /subscribers/{id}/blocklist](https://octri-zj36wftkny47.octri.dev/put-subscribers-id-blocklist): Manage a subscriber's blocklist
- [GET /subscribers/{id}/bounces](https://octri-zj36wftkny47.octri.dev/get-subscribers-id-bounces): Get bounce records for a subscriber
- [DELETE /subscribers/{id}/bounces](https://octri-zj36wftkny47.octri.dev/delete-subscribers-id-bounces): Delete bounce records for a subscriber
- [GET /subscribers/{id}/export](https://octri-zj36wftkny47.octri.dev/get-subscribers-id-export): Export a subscriber's data
- [POST /subscribers/{id}/optin](https://octri-zj36wftkny47.octri.dev/post-subscribers-id-optin): Send an opt-in confirmation email
- [PUT /subscribers/blocklist](https://octri-zj36wftkny47.octri.dev/put-subscribers-blocklist): Manage the subscriber blocklist
- [PUT /subscribers/lists](https://octri-zj36wftkny47.octri.dev/put-subscribers-lists): Manage subscriber list membership
- [PUT /subscribers/lists/{id}](https://octri-zj36wftkny47.octri.dev/put-subscribers-lists-id): Manage subscriber membership in a list
- [PUT /subscribers/query/blocklist](https://octri-zj36wftkny47.octri.dev/put-subscribers-query-blocklist): Manage the blocklist for subscribers by query
- [POST /subscribers/query/delete](https://octri-zj36wftkny47.octri.dev/post-subscribers-query-delete): Delete subscribers by query
- [PUT /subscribers/query/lists](https://octri-zj36wftkny47.octri.dev/put-subscribers-query-lists): Manage subscriber lists by query

## API Reference › Templates
- [GET /templates](https://octri-zj36wftkny47.octri.dev/get-templates): List templates
- [POST /templates](https://octri-zj36wftkny47.octri.dev/post-templates): Create a template
- [GET /templates/{id}](https://octri-zj36wftkny47.octri.dev/get-templates-id): Get a template by ID
- [PUT /templates/{id}](https://octri-zj36wftkny47.octri.dev/put-templates-id): Replace a template
- [DELETE /templates/{id}](https://octri-zj36wftkny47.octri.dev/delete-templates-id): Delete a template
- [PUT /templates/{id}/default](https://octri-zj36wftkny47.octri.dev/put-templates-id-default): Set a template as the default
- [GET /templates/{id}/preview](https://octri-zj36wftkny47.octri.dev/get-templates-id-preview): Preview a template by ID
- [POST /templates/preview](https://octri-zj36wftkny47.octri.dev/post-templates-preview): Preview a template

## API Reference › Tx
- [POST /tx](https://octri-zj36wftkny47.octri.dev/post-tx): Send a transactional message to a subscriber

## Optional
- [SDK Downloads](https://octri-zj36wftkny47.octri.dev/sdk): Client SDKs in TypeScript, Python, Go, and 7 more languages
- [Changelog](https://octri-zj36wftkny47.octri.dev/changelog): API version history and breaking changes