POST
/
mailstack
/
v1
/
domains
/
{domain}
/
mailboxes

Authorizations

X-CUSTOMER-OS-API-KEY
string
headerrequired

Path Parameters

domain
string
required

Domain for which to register the mailbox

Body

application/json
forwardingEnabled
boolean

Specifies if email forwarding is enabled Example: true

forwardingTo
string[]

Email address to forward to (if forwarding is enabled) Example: johndoe.forward@example.com

password
string
required

Password for the mailbox (e.g., "SecurePassword123!") Required: true Example: SecurePassword123!

username
string
required

Username for the mailbox (e.g., "john.doe") Required: true Example: john.doe

webmailEnabled
boolean

Specifies if webmail access is enabled Example: true

Response

200 - application/json
email
string

Email is the email address for the mailbox Required: true Example: user@example.com

forwardingEnabled
boolean

ForwardingEnabled indicates if email forwarding is enabled Example: true

forwardingTo
string[]

ForwardingTo is the email address the mailbox forwards to Example: user@forward.com

message
string

Message provides additional information about the action Example: Mailbox setup successful

status
string

Status indicates the result of the action Example: success

webmailEnabled
boolean

WebmailEnabled indicates if webmail access is enabled Example: true