Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Subscribers → Import Subscribers

AI-generated

Summary

Import Subscribers

Inputs

  • authentication (required) — Authentication method to use: OAuth2 or API Key.
  • path_domain (required) — The Infomaniak domain (sub‑domain) where the newsletter resides.
  • body_fields (required) — JSON object mapping Infomaniak field IDs (or field description objects) to the incoming data fields that should be imported.
  • bodyParameters — Additional options for the import: CSV enclosure character, CSV separator character, groups to assign, IPD UUID, whether to replace existing fields, and an upload ID.
  • returnFullResponse — If true, returns the full HTTP response from the Infomaniak API; otherwise returns only the processed items.

Output shape

json

When returnFullResponse is false, the output is an array of items representing the imported subscribers; when true, the entire API response object is returned.

Examples

Example 1: Import a CSV of subscribers into a newsletter

Set authentication to API Key, provide your domain, map CSV columns to Infomaniak field IDs via body_fields, optionally specify CSV separator and enclosure in bodyParameters, and leave returnFullResponse false to get a tidy list of imported records.

Links

Discussion