API Docs / Schemas / UpdateEmailConfigRequest

UpdateEmailConfigRequest

Changes to a connection: a property left out keeps its value.

Properties

Name Type Description
fromEmailstring

The address the emails are from (SMTP only: Outlook and Gmail send from the mailbox that signed in)

The address the emails are from (SMTP only: Outlook and Gmail send from the mailbox that signed in)

fromNamestring

The name the emails are from

The name the emails are from

isDefaultboolean

True makes it the connection the tenant's emails go through, in place of the current one

True makes it the connection the tenant's emails go through, in place of the current one

smtpSettingsEmailSmtpSettingsRequest

The SMTP settings (SMTP only)

The SMTP settings (SMTP only)

JSON Example

{
  "fromEmail": "user@example.com",
  "fromName": "string",
  "isDefault": false,
  "smtpSettings": {
    "host": "string",
    "port": 1,
    "encryption": "...",
    "requiresAuthentication": false,
    "username": "string"
  }
}

Used By Operations