Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Users → Send An Invitation

AI-generated

Summary

Send an invitation to a mailbox user

Inputs

  • authentication — Authentication method (OAuth2 or API Key)
  • path_mail_hosting_id (required) — Unique identifier of the mail hosting
  • path_mailbox_name (required) — Username (part before @) of the email address
  • bodyParameters — Additional fields for the invitation body (email, firstname, etc.)
  • returnFullResponse — Whether to return the full API response

Output shape

a single record indicating the result of the invitation request

Success returns a JSON response; errors return an error envelope with details.

Examples

Example 1: Invite a new user via OAuth2

authentication: oauth2; path_mail_hosting_id: 5; path_mailbox_name: john.doe; bodyParameters: {email: 'john@example.com', firstname: 'John'}; returnFullResponse: false

Example 2: Invite using API Key

authentication: apiKey; path_mail_hosting_id: 3; path_mailbox_name: alice; bodyParameters: {email: 'alice@example.com', lastname: 'Smith'}; returnFullResponse: true

Links

Discussion