Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailing List > Subscribers → Remove A Subscriber

AI-generated

Summary

Remove a subscriber from a mailing list.

Inputs

  • authentication — Authentication method, either OAuth2 or API Key.
  • path_mail_hosting_id (required) — Identifier of the Infomaniak mail hosting.
  • path_mailing_list_name (required) — Name of the mailing list.
  • bodyParameters — Additional body fields to include in the request.
  • returnFullResponse — If true, the full API response is returned; otherwise only a success flag.

Output shape

success indicator (or full response when requested)

When returnFullResponse is false a minimal success/failure object is returned; when true the full API response object is returned.

Examples

Example 1: Remove a subscriber via OAuth2

authentication: oauth2; path_mail_hosting_id: 123; path_mailing_list_name: "Newsletter"; bodyParameters: {}; returnFullResponse: false

Example 2: Remove a subscriber with extra body field using API key

authentication: apiKey; path_mail_hosting_id: 456; path_mailing_list_name: "Promotions"; bodyParameters: {"body_emails": "user@example.com"}; returnFullResponse: true

Links

Discussion