Mailboxes

Update mailbox connection settings

Updates SMTP and/or IMAP credentials without recreating or disconnecting the mailbox. Each supplied leg requires host, port, username and password; omitted legs and mailbox metadata are unchanged. Both supplied legs are verified before saving. Uses the same TLS settings and fallback as mailbox connection. If the mail provider has no account for this mailbox, send both SMTP and IMAP; the account is registered again. OAuth mailboxes require provider reauthorization.

patch/workspaces/{workspaceID}/mailboxes/{mailboxID}/connection-settings

Request

  • Base URL
    https://api.salesforge.ai/public/v2
  • Auth
    API key in header Authorization

Path parameters

workspaceIDstring required

Workspace ID

mailboxIDstring required

Mailbox ID

Request body

object required
OR

Example request

{
  "imap": {
    "host": "mail.example.com",
    "port": 587,
    "username": "jane@example.com"
  },
  "smtp": {
    "host": "mail.example.com",
    "port": 587,
    "username": "jane@example.com"
  }
}

Response

No Content

Changes

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