Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Subscribers → Export Subscribers

AI-generated

Summary

Export subscribers from an Infomaniak newsletter domain.

Inputs

  • authentication — Authentication method for the Infomaniak API. Defaults to OAuth2; API Key can be selected instead.
  • path_domain (required) — Unique identifier of the Domain. Must be provided as a numeric domain ID.
  • body_select (required) — JSON specification of fields or selector to determine which subscriber data is exported.
  • bodyParameters — Optional additional parameters for the export request. Contains sub-fields: body_filter (JSON) to filter subscribers, and body_segment (string) to filter by a specific segment.
  • returnFullResponse — If true, the full API response body is returned as the operation output; otherwise only subscriber items are returned.

Output shape

Subscriber export data from the Infomaniak API. Structure depends on the body_select configuration and returnFullResponse setting.

The operation constructs an API request using the provided domain ID, authentication, and body parameters. The infomaniakApiRequest helper (from GenericFunctions.js) handles the actual HTTP call. Authentication is resolved per the selected method (OAuth2 or API Key).

Links

Discussion