Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Service Mail > Filters Models → Update A Filter Model

AI-generated

Summary

Update a specific mail filter model by setting its properties and optional body fields.

Inputs

  • authentication — Authentication method; either OAuth2 or API Key.
  • path_mail_hosting_id (required) — Identifier of the mail hosting containing the filter.
  • path_filter_id (required) — Identifier of the filter model to update.
  • body_is_visible (required) — Visibility flag for the filter.
  • body_name (required) — Name of the filter.
  • bodyParameters — Additional body fields such as actions, conditions, etc.
  • body_actions — JSON object defining filter actions.
  • body_conditions — JSON object defining filter conditions.
  • body_has_all_conditions — Boolean indicating if all conditions must be met.
  • body_script — Inline script for custom processing.
  • returnFullResponse — Whether to return the full API response.

Output shape

a single updated filter model object

Returns the updated filter details; unchanged fields may be omitted.

Examples

Example 1: Update filter visibility and name

Set auth to OAuth2, host ID 123, filter ID 456, is_visible true, name "Spam", returnFullResponse false.

Example 2: Add custom script and actions

Provide body_script "return JSON.parse(data)"; body_actions {"forward":true} with OAuth2 auth, host 123, filter 456.

Example 3: Bulk update with conditions

Define body_conditions {"subject":"urgent"}; body_has_all_conditions true; use API Key auth, host 789, filter 012.

Links

Discussion