Actions118
- Mailbox Management Actions
- Mailboxes Actions
- Mailboxes > Accesses > Devices Actions
- Mailboxes > Accesses > Invitations Actions
- Mailboxes > Accesses > Webmail Actions
- List User Access And Invitations
- Create Webmail Access
- Set The Primary Mailbox For The Authenticated User
- List Users Having Access
- List Of User Accesses For The Current User
- List Of User Accesses For A Account And A User
- Update Webmail Access
- Delete Webmail Access
- Delete Access To A Mailbox For The Current User
- Mailboxes > Aliases Actions
- Mailboxes > Auto Reply Actions
- Mailboxes > Folders Actions
- Mailboxes > Forwarding Actions
- Mailboxes > Sieve Filters Actions
- Mailboxes > Signatures Actions
- Mailboxes > Users Actions
- Mailing List Actions
- Mailing List > Subscribers Actions
- Service Mail > Auto Reply Actions
- Service Mail > Bimi Actions
- Service Mail > Filters Models Actions
- Service Mail > Preferences Actions
- Service Mail > Redirections Actions
- Service Mail > Redirections > Target Actions
- Service Mail > Signatures Templates Actions
Mailboxes > Users → Send An Invitation
AI-generatedSummary
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