API Docs / Schemas / CreateEmailConfigRequest

CreateEmailConfigRequest

Request DTO for creating a new email configuration

Properties

Name Type Description
providerType*enum

Represents the type of email provider

Smtp SendGrid Microsoft365 Google

Represents the type of email provider

Smtp SendGrid Microsoft365 Google

fromEmail*string

The sender email address for this configuration

The sender email address for this configuration

fromNamestring

The sender display name (optional)

The sender display name (optional)

isDefaultboolean

Whether to set this as the tenant's default email configuration.
If true, IsShared must also be true.

Whether to set this as the tenant's default email configuration.
If true, IsShared must also be true.

isSharedboolean

Whether this configuration is shared with all users in the tenant

Whether this configuration is shared with all users in the tenant

smtpSettingsSmtpSettingsRequest
oAuthSettingsOAuthSettingsRequest

JSON Example

{
  "providerType": "Smtp",
  "fromEmail": "string",
  "fromName": "string",
  "isDefault": false,
  "isShared": false
}

Used By Operations