Sign in
Mailboxes

Update Mailbox

patch/api/v1/mail/mailboxes/{email_address}

Path parameters

email_addressstring required

Request body

filter_mode'whitelist' | 'blacklist'

Response

Successful Response

idstring uuid required
email_addressstring required
status'active' | 'paused' | 'deleted'
sending_domainstring

Bare domain the mailbox sends from, derived from email_address. Matches the platform default (inkboxmail.com) or the customer's verified custom domain.

filter_mode'whitelist' | 'blacklist' required
agent_identity_idstring uuid nullable

ID of the agent identity that owns this mailbox, or null on tombstones / system mailboxes.

created_atstring date-time required
updated_atstring date-time required
storage_used_bytesinteger

Live storage used by this inbox, in bytes.

storage_limit_bytesinteger nullable

Resolved plan-tiered storage cap in bytes; null when the route did not resolve it (the ORM does not carry the cap).

unread_countinteger nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.