API Docs / Schemas / UpdateEmailConfigRequest

UpdateEmailConfigRequest

Request DTO for updating an existing email configuration

Properties

Name Type Description
fromEmailstring

Updated sender email address (optional, null to keep existing).
Cannot be changed on OAuth configurations that are currently connected.

Updated sender email address (optional, null to keep existing).
Cannot be changed on OAuth configurations that are currently connected.

fromNamestring

Updated sender display name (optional, null to keep existing)

Updated sender display name (optional, null to keep existing)

isDefaultboolean

Whether to set this as the tenant's default email configuration.
Cannot be true unless IsShared is also true. Null to keep existing.

Whether to set this as the tenant's default email configuration.
Cannot be true unless IsShared is also true. Null to keep existing.

isSharedboolean

Whether this configuration is shared with all users in the tenant.
Cannot be set to false on the current default config. Null to keep existing.

Whether this configuration is shared with all users in the tenant.
Cannot be set to false on the current default config. Null to keep existing.

smtpSettingsSmtpSettingsRequest
oAuthSettingsOAuthSettingsRequest

JSON Example

{
  "fromEmail": "string",
  "fromName": "string",
  "isDefault": false,
  "isShared": false,
  "smtpSettings": {
    "host": "string",
    "port": 0,
    "encryption": "...",
    "requiresAuthentication": false,
    "username": "string"
  }
}

Used By Operations