Skip to main content
POST
Create or update an identity mailbox

Authorizations

x-api-key
string
header
required

Path Parameters

identityId
string
required

The identity ID that will own the mailbox.

Body

application/json
email
string<email>
required

Mailbox email address

provider
enum<string>
required

Mailbox provider. Programmatic setup currently supports IMAP mailboxes only.

Available options:
imap
credentials
object
required
makePrimary
boolean
default:false

When true, also updates the identity primary email to this mailbox address.

Response

Mailbox updated successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required