Actions70
- API Key Actions
- Campaigns Actions
- Credits Actions
- Domains Actions
- Fields Actions
- Groups Actions
- Operations Actions
- Segments Actions
- Subscribers Actions
- Templates Actions
- Webforms Actions
Segments → Create A Segment
AI-generatedSummary
Create a newsletter segment in Infomaniak.
Inputs
- authentication — Authentication method to use for the Infomaniak API call.
- path_domain (required) — Unique identifier of the Domain.
- body_data (required) — Request body data provided as JSON.
- body_name (required) — Name of the resource {name}.
- returnFullResponse — Return the full API response body instead of a parsed item.
Output shape
Returns a single item representing the created segment. If returnFullResponse is enabled, the item contains the complete API response payload; otherwise, it contains the segment identifier and name.
The operation consumes the domain ID and body data to create the segment. Authentication is handled via the selected method (OAuth2 or API Key).
Examples
Example 1: Create a segment named 'Newsletter Subscribers' under domain ID 12345 using OAuth2.
Set authentication to OAuth2, path_domain to 12345, body_data to {}, and body_name to 'Newsletter Subscribers'.