Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

User Management > Accounts > Invitations > Mailbox → Update A Mailbox Access

AI-generated

Summary

Update a mailbox access (name and permissions) for a given invitation in an Infomaniak account.

Inputs

  • Authentication (required) — Authentication method to use: OAuth2 (default) or API Key.
  • Account (required) — Numeric ID of the Infomaniak account containing the invitation.
  • Invitation (required) — Numeric ID of the invitation whose mailbox access is being updated.
  • Mail Id (required) — String ID of the mailbox to update.
  • Mailbox Name (required) — New name to set for the mailbox.
  • Mailbox Permissions (required) — JSON object defining the permissions for the mailbox (e.g., read, write, admin).
  • Return Full Response — If true, returns the raw API response; otherwise returns processed data. Default: false.

Output shape

When Return Full Response is false: processed mailbox access data (typically the updated mailbox object). When true: the full HTTP response from the Infomaniak API.

The operation performs a PUT request to the Infomaniak endpoint for updating a mailbox under an invitation, using the provided account, invitation, and mailbox IDs, with the mailbox name and permissions in the request body.

Examples

Example 1: Rename a mailbox and adjust its permissions

Set Authentication to OAuth2, Account to 12345, Invitation to 67890, Mail Id to 'mbx_abcde', Mailbox Name to 'Shared Inbox', Mailbox Permissions to {'read': true, 'write': false, 'admin': true}, Return Full Response to false.

Links

Discussion