Mailboxes

Update a mailbox

Partial update — only the fields you send change. Changing SMTP/IMAP credentials re-runs the connection test. Set external_id or signature to null to clear them.

Required scope: mailboxes:write.

patch/mailboxes/{id}

Request

  • Base URL: https://warmysender.com/api/v1
  • URL: https://warmysender.com/api/v1/mailboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Mailbox id (UUID).

Request body

display_namestring

Display name.

smtp_hoststring

SMTP host.

smtp_portinteger

SMTP port (25/465/587).

smtp_usernamestring

SMTP login.

smtp_passwordstring password

SMTP password.

imap_hoststring

IMAP host.

imap_portinteger

IMAP port (143/993).

imap_usernamestring

IMAP login.

imap_passwordstring password

IMAP password.

sending_enabledboolean

Allow sending.

daily_send_limitinteger

Daily send cap.

external_idstring nullable

Your reference id, or null to clear.

signaturestring nullable

HTML/text signature, or null to clear.

Response

Success

Changes

No recorded changes to this operation across all 2 revisions of this API.