Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Users → Add An Invitation

AI-generated

Summary

Create an invitation for a mailbox user via Infomaniak API.

Inputs

  • authentication — Authentication method: OAuth2 or API Key.
  • path_mail_hosting_id (required) — Unique identifier of the mail hosting containing the target mailbox.
  • path_mailbox_name (required) — Username part of the email address to invite.
  • body_permissions (required) — Permissions JSON object for the invitation.
  • bodyParameters — Additional fields such as firstname, lastname, force email, send email, signature template ID.
  • returnFullResponse — If true, the full API response is returned; otherwise only success/failure is indicated.

Output shape

A single invitation record created by the API

The returned object contains the created invitation details; when returnFullResponse is false only a success indicator is provided.

Examples

Example 1: Add invitation using OAuth2

authentication=oauth2, path_mail_hosting_id=12, path_mailbox_name=john, body_permissions={}, bodyParameters={{firstname='John', lastname='Doe', send_email=true}}, returnFullResponse=true

Example 2: Add invitation using API Key

authentication=apiKey, path_mail_hosting_id=7, path_mailbox_name=alice, body_permissions={"role":"admin"}, bodyParameters={{force_email=1}}, returnFullResponse=false

Example 3: Add invitation with custom permissions

authentication=oauth2, path_mail_hosting_id=3, path_mailbox_name=bob, body_permissions={"read":true}, bodyParameters={{signature_template_id='sig-001'}}

Links

Discussion