Actions70
- API Key Actions
- Campaigns Actions
- Credits Actions
- Domains Actions
- Fields Actions
- Groups Actions
- Operations Actions
- Segments Actions
- Subscribers Actions
- Templates Actions
- Webforms Actions
Subscribers → Delete Subscribers
AI-generatedSummary
Delete subscribers from an Infomaniak Newsletter domain using a selector and optional filter or segment.
Inputs
- authentication — Authentication method: OAuth2 or API Key. Defaults to OAuth2.
- path_domain (required) — Unique identifier of the Domain.
- body_select (required) — Selection criteria for subscribers to delete (e.g., list of IDs or query).
- bodyParameters — Additional body fields for the delete request. Contains optional filter and segment sub‑fields.
- returnFullResponse — If true, returns the full API response; otherwise returns a simplified result.
Output shape
Depends on returnFullResponse. When false, returns a simplified summary (e.g., count of deleted subscribers). When true, returns the full API response object from the Infomaniak delete endpoint.
The operation uses the domain ID, the selector (body_select), and any optional filter/segment supplied via bodyParameters to identify which subscribers to remove from the newsletter.
Examples
Example 1: Delete a specific list of subscriber IDs from domain 123.
Set path_domain to 123, body_select to the array of IDs, leave bodyParameters empty, and keep returnFullResponse false to get a brief confirmation.