Mailing Lists
All operations require authentication, except the one marked Public.
Get mailing list limitsProductionPublic
Get mailing list limits. Returns the maximum number of subscribers of a mailing list, with or without message moderation (moderatorMessage).
Query parameters
If true, messages are moderate
Response
Maximum number of subscribers
Public: no token needed
$ curl https:/{ "subscribers": 0}
List mailing listsProduction
List mailing lists. Returns the names of the mailing lists of the domain. Filter them by name to look for a given list.
Path parameters
Name of your domain name
Query parameters
Mailing list name
Response
Example uses domain = string
$ curl https:/[ "string"]
Get a mailing listProduction
Get a mailing list. Returns the owner email, reply-to address, language, moderation options and number of subscribers of the mailing list.
Path parameters
Name of your domain name
Name of mailing list
Response
Id of mailing list
Language of mailing list
deenesfritnlplptName of mailing list
Subscribers number of mailing list
Last update subscribers
Options of mailing list
Owner email of mailing list
Email to reply of mailing list
Example uses domain = string, name = string
$ curl https:/{ "id": 0, "language": "de", "name": "string", "nbSubscribers": 0, "nbSubscribersUpdateDate": "2024-01-01T12:00:00Z", "options": { "moderatorMessage": true, "subscribeByModerator": true, "usersPostOnly": true }, "ownerEmail": "string", "replyTo": "string"}
Create a mailing listProduction
Create a mailing list. Creates a mailing list with a name, an owner email, a language and moderation options, and returns the task.
Path parameters
Name of your domain name
Request body (required)
Language of mailing list
deenesfritnlplptMailing list name
Options of mailing list
Owner Email
Email to reply of mailing list
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
Delete a mailing listProduction
Delete a mailing list. Deletes the mailing list of the domain with its subscribers and moderators, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
Update a mailing listProduction
Update a mailing list. Updates the owner email, the reply-to address or the language of the mailing list.
Path parameters
Name of your domain name
Name of mailing list
Request body (required)
Id of mailing list
Language of mailing list
deenesfritnlplptName of mailing list
Subscribers number of mailing list
Last update subscribers
Options of mailing list
Owner email of mailing list
Email to reply of mailing list
Response
Example uses domain = string, name = string
$ curl https:/Change mailing list optionsProduction
Change mailing list options. Sets message moderation (moderatorMessage), subscription moderation (subscribeByModerator) and usersPostOnly, which lets only moderators post, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Request body (required)
Options of mailing list
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
List moderatorsProduction
List moderators. Returns the email addresses of the moderators of the mailing list. Filter them by email.
Path parameters
Name of your domain name
Name of mailing list
Query parameters
Moderator email
Response
Example uses domain = string, name = string
$ curl https:/[ "string"]
Get a moderatorProduction
Get a moderator. Returns the email address of the moderator and the mailing list and domain it moderates.
Path parameters
Name of your domain name
Name of mailing list
Response
Example uses domain = string, email = string, name = string
$ curl https:/{ "domain": "string", "email": "string", "mailinglist": "string"}
Add a moderatorProduction
Add a moderator. Makes the email address a moderator of the mailing list, who approves the messages, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Request body (required)
Email of moderator
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
Remove a moderatorProduction
Remove a moderator. Withdraws the moderator role from the email address on the mailing list, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, email = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
Send member lists by emailProduction
Send member lists by email. Sends the lists of moderators and subscribers of the mailing list to the email address, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Request body (required)
Email destination
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
List subscribersProduction
List subscribers. Returns the email addresses of the subscribers of the mailing list. Filter them by email.
Path parameters
Name of your domain name
Name of mailing list
Query parameters
Subscriber email
Response
Example uses domain = string, name = string
$ curl https:/[ "string"]
Get a subscriberProduction
Get a subscriber. Returns the email address of the subscriber and the mailing list and domain it is subscribed to.
Path parameters
Name of your domain name
Name of mailing list
Response
Example uses domain = string, email = string, name = string
$ curl https:/{ "domain": "string", "email": "string", "mailinglist": "string"}
Add a subscriberProduction
Add a subscriber. Subscribes the email address to the mailing list, so that it receives its messages, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Request body (required)
Email of subscriber
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}
Remove a subscriberProduction
Remove a subscriber. Unsubscribes the email address from the mailing list, which it no longer receives, and returns the task.
Path parameters
Name of your domain name
Name of mailing list
Response
Possible values for mailing list language
deenesfritnlplptExample uses domain = string, email = string, name = string
$ curl https:/{ "account": "string", "action": "string", "date": "2024-01-01T12:00:00Z", "domain": "string", "id": 0, "language": "de"}