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 → Set The Primary Mailbox For The Authenticated User
AI-generatedSummary
Set the primary mailbox for the authenticated user
Inputs
- authentication — Authentication method to use; either OAuth2 or API Key.
- path_mailbox_id (required) — The unique identifier (ID) of the email address to set as primary.
- returnFullResponse — If true, the full API response is returned; otherwise only a success indicator.
Output shape
no body — success/failure only
Returns a confirmation payload when returnFullResponse is true; otherwise just a success/failure indicator.
Examples
Example 1: Set primary mailbox via OAuth2
authentication: oauth2; path_mailbox_id: 42; returnFullResponse: false
Example 2: Set primary mailbox via API Key
authentication: apiKey; path_mailbox_id: 7; returnFullResponse: true