Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailing List > Subscribers → Import Subscribers

AI-generated

Summary

Import a list of subscribers into a specified Infomaniak mailing list.

Inputs

  • authentication (required) — Authentication method selecting between OAuth2 or API Key.
  • path_mail_hosting_id (required) — Identifier of the mail hosting (mailbox) where the mailing list resides.
  • path_mailing_list_name (required) — Name of the mailing list to which subscribers will be imported.
  • body_datas (required) — Text containing one subscriber per line in the format "email address, name".
  • returnFullResponse — If true, the full API response is returned; otherwise only a success indicator.

Output shape

An object indicating the result of the import operation (e.g., success status, imported count, or full API response when enabled).

The operation does not return subscriber data; it returns control information about the import job.

Examples

Example 1: Add two new subscribers using API Key authentication.

authentication: apiKey
path_mail_hosting_id: 12345
path_mailing_list_name: Newsletter
body_datas: alice@example.com, Alice
bob@example.org, Bob
returnFullResponse: false

Example 2: Import subscribers via OAuth2 and receive the complete API response.

authentication: OAuth2
path_mail_hosting_id: 12345
path_mailing_list_name: Newsletter
body_datas: alice@example.com, Alice
bob@example.org, Bob
returnFullResponse: true

Example 3: Batch import of multiple mailing lists in a workflow.

authentication: apiKey
path_mail_hosting_id: 12345
path_mailing_list_name: Newsletter
body_datas: alice@example.com, Alice
bob@example.org, Bob
returnFullResponse: false

Links

Discussion