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 > Accesses > Webmail → Create Webmail Access
AI-generatedSummary
Create a webmail access for a mailbox.
Inputs
- authentication — Authentication method: OAuth2 or API Key.
- path_service_mail (required) — Mail hosting ID to associate with the access.
- path_mailbox_name (required) — Email username (part before @) for the mailbox.
- body_user_id (required) — User ID of the mailbox owner.
- bodyParameters — Optional additional parameters such as permissions.
- returnFullResponse — If true, the full API response is returned; otherwise only success/failure.
Output shape
A JSON object with the created webmail access details (e.g., ID, email, permissions) when returnFullResponse is true; otherwise a simple success indicator.
May include pagination or error envelopes in actual responses.
Examples
Example 1: Add a new webmail access using API Key for mailbox john.doe@example.com.
authentication=apiKey, path_service_mail=5, path_mailbox_name=john.doe, body_user_id=12345, bodyParameters={permissions:{read:true,write:false}}