Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

User Management > Accounts > Invitations > Mailbox → Create Invite

AI-generated

Summary

Create a mailbox invitation in Infomaniak

Inputs

  • Authentication (required) — Authentication method (OAuth2 or API Key) used to call the Infomaniak API.
  • Account (required) — Account identifier (path parameter).
  • Invitation (required) — Invitation identifier (path parameter).
  • Email (required) — Email address to receive the invitation.
  • Key (required) — Key associated with the invitation.
  • Mail Id (required) — Numeric ID of the mailbox.
  • Mailbox Name (required) — Display name for the mailbox.
  • Password — Optional password for the mailbox invitation (additional body field).
  • Return Full Response — When true, returns the full API response; otherwise returns a simplified result.

Output shape

object

Returns the created invitation data. If Return Full Response is false, a trimmed response with essential fields is returned; if true, the complete Infomaniak API response is returned.

Examples

Example 1: Invite a user to a mailbox

Set Authentication to OAuth2, provide Account and Invitation IDs, fill Email, Key, Mail Id, Mailbox Name, optionally Password, and leave Return Full Response unchecked.

Links

Discussion