createMailbox
Stage creation of a paid mailbox on a mail-enabled domain. BILLABLE — deducts from account balance; get a quote with getMailboxQuote and confirm the price with the user first. Requires authentication. Required: domain (an ACTIVE mail domain), localPart (the part before the @), packageId (from listMailPlans — there is no default). Optional: term ('MONTHLY' or 'ANNUAL', default ANNUAL). Returns an actionId — present the summary to the user, then call executeConfirmedAction with the actionId if they approve. The result of the confirmed action contains the generated password EXACTLY ONCE — it can never be retrieved again, so show it to the user immediately; the user can change it later with setMailboxPassword. Also share the client settings from the result (IMAP/SMTP/webmail).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| term | No | ||
| domain | Yes | ||
| localPart | Yes | ||
| packageId | Yes | ||
| sessionKey | No | Session key (osk_...) returned by checkDeviceLoginStatus. Pass it on every call when logged in via the in-chat device flow; omit when connected via OAuth. |