INinkbox
Mailboxes

Update Mailbox

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

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/mail/mailboxes/{email_address}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

email_addressstring required

Request body

filter_mode'whitelist' | 'blacklist'
signature_htmlstring nullable

HTML signature fragment. Sanitized before saving. Null clears it; omitted fields are unchanged. When supplied without signature_text, a plain-text fallback is generated. Images require absolute HTTPS URLs.

signature_textstring nullable

Plain-text signature. Null clears it; omitted fields are unchanged unless HTML is updated. When null, sending derives text from signature_html if present.

signature_enabledboolean nullable

Automatically insert the saved signature when the organization has custom signatures enabled. Defaults to false. Omit to leave unchanged; null is rejected.

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
inbound_filter_mode'whitelist' | 'blacklist'
outbound_filter_mode'whitelist' | 'blacklist'
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).

signature_htmlstring nullable
signature_textstring nullable
signature_enabledboolean
unread_countinteger nullable

Changes

  • f3dcdb50fbaaRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 8fdfe5fd9d6bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status