Skip to main content
PATCH
Update a mailbox domain

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-Match
string

Weak ETag from a prior GET. Reject with 409 conflict when the server's current ETag differs.

Path Parameters

public_id
string
required

Domain public ID

Example:

"mdom_clxxxxxxxxxxxxxxxxxxxxxxxxx"

Body

application/json
mode
enum<string>
required

The only supported update is upgrading to send_receive.

Available options:
send_receive
Example:

"send_receive"

Response

Updated domain

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required