Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Users → Update Invitation Permission

AI-generated

Summary

Update the invitation permission for a mailbox user on a specified mail hosting

Inputs

  • authentication (required) — Authentication method to use (OAuth2 or API Key)
  • path_mail_hosting_id (required) — ID of the mail hosting containing the mailbox
  • path_mailbox_name (required) — Username part of the email address of the mailbox
  • path_key (required) — Invitation key identifying the permission to update
  • body_force_email — If true, forces sending an email to the user
  • body_permissions — JSON object with permission settings to apply
  • returnFullResponse — If true, returns the full API response; otherwise a summary

Output shape

a single object representing the updated invitation, or a success flag if not returning full data

When returnFullResponse is true the response includes all fields from the API; otherwise only a status indicator is returned

Examples

Example 1: Set permissions for user john in hosting 123

authentication=oauth2, path_mail_hosting_id=123, path_mailbox_name=john, path_key=inv123, body_permissions={"read":true,"write":false}, returnFullResponse=true

Example 2: Force email resend for user alice

authentication=apiKey, path_mail_hosting_id=456, path_mailbox_name=alice, path_key=inv456, body_force_email=true, body_permissions={"read":true}, returnFullResponse=false

Links

Discussion