Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Accesses > Webmail → Update Webmail Access

AI-generated

Summary

Updates a webmail access for a given mailbox and user.

Inputs

  • authentication — Authentication method: either OAuth2 or API Key.
  • path_service_mail (required) — The unique identifier (ID) of the mail hosting to request.
  • path_mailbox_name (required) — The username (part before @) of the email address to request.
  • path_user_id (required) — The unique identifier (ID) of the user to request.
  • body_permissions (required) — Permissions to assign to the webmail access as a JSON object.
  • returnFullResponse — If true, the full response from the API is returned; otherwise only a success indicator.

Output shape

a single object representing the updated webmail access

Response contains the updated access details; when returnFullResponse is false the body may be minimal. Errors return a standard error envelope.

Examples

Example 1: Update a webmail access using OAuth2 for mailbox john@example.com with service ID 3 and user ID 42, granting read/write permissions.

authentication: oauth2; path_service_mail: 3; path_mailbox_name: john; path_user_id: 42; body_permissions: {"read":true,"write":true}; returnFullResponse: false

Links

Discussion