Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailing List → Update Mailing List Parameters

AI-generated

Summary

Updates the parameters of an Infomaniak mailing list.

Inputs

  • authentication (required) — Authentication method: 'oauth2' or 'apiKey'.
  • path_mail_hosting_id (required) — Identifier of the mail hosting.
  • path_mailing_list_name (required) — Name of the mailing list to update.
  • body_info (required) — Info message for the mailing list.
  • body_is_reply_to_forced (required) — Whether the sender's email is forced to the mailing list email.
  • body_max_message_size (required) — Maximum size of a message in bytes.
  • body_moderators (required) — List of moderator emails.
  • body_should_send_notifications (required) — Whether welcome/goodbye notifications are sent.
  • body_subject (required) — Subject used for system messages.
  • body_use_reply_to (required) — Whether replies are redirected to the mailing list email.
  • body_who_can_send (required) — Who is allowed to send emails (0-5 options).
  • body_who_can_subscribe (required) — Subscription policy (0-2 options).
  • bodyParameters — Additional fields such as greeting and language settings.
  • returnFullResponse — When true, the full updated object is returned.

Output shape

a single object representing the updated mailing list

If returnFullResponse is true the full response is returned; otherwise only a success indicator is emitted.

Examples

Example 1: Set mailing list to public with English language

authentication: oauth2, path_mail_hosting_id: 123, path_mailing_list_name: Newsletter, body_who_can_send: 5, body_who_can_subscribe: 0, body_parameters: {welcome_message: 'Welcome!', body_lang: 'en'}

Example 2: Force reply-to and enable notifications

authentication: apiKey, path_mail_hosting_id: 456, path_mailing_list_name: Support, body_is_reply_to_forced: true, body_should_send_notifications: true, body_use_reply_to: true

Example 3: Disable all sending except moderators

authentication: oauth2, path_mail_hosting_id: 789, path_mailing_list_name: Private, body_who_can_send: 1, body_who_can_subscribe: 2

Links

Discussion