Skip to main content
PATCH
Update a mailbox

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

Mailbox public ID

Body

application/json
display_name
string | null

Replace the display name; send null to clear it.

Required string length: 1 - 254
quota_bytes
integer

Storage quota in bytes. Allowed values: 1073741824 (1 GB), 5368709120 (5 GB), 53687091200 (50 GB).

Required range: x >= 1
Example:

5368709120

send_scope
object

Replace outbound routing restrictions.

Response

Updated mailbox

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