UpdateEmailConfigRequest - SodiumHQ API Schema

Properties

Name	Type	Description
fromEmail	string	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.
fromName	string	Updated sender display name (optional, null to keep existing)
Updated sender display name (optional, null to keep existing)
isDefault	boolean	Whether to set this as the tenant's default email configuration. Cannot be true unless IsSendShared is also true. Null to keep existing.
Whether to set this as the tenant's default email configuration. Cannot be true unless IsSendShared is also true. Null to keep existing.
isSendShared	boolean	Whether all users in the tenant can send emails from this configuration. Cannot be set to false on the current default config. Null to keep existing.
Whether all users in the tenant can send emails from this configuration. Cannot be set to false on the current default config. Null to keep existing.
readSharing	enum	Private Everyone Selected
Private Everyone Selected
shareClientEmails	boolean	With ReadSharing Selected, whether colleagues also see every email with a client. Only the owner can change it. Null to keep existing. Saved as false whenever the effective read-sharing is not Selected.
With ReadSharing Selected, whether colleagues also see every email with a client. Only the owner can change it. Null to keep existing. Saved as false whenever the effective read-sharing is not Selected.
signature	string	Updated HTML email signature (empty string to clear, null to keep existing)
Updated HTML email signature (empty string to clear, null to keep existing)
smtpSettings	SmtpSettingsRequest
oAuthSettings	OAuthSettingsRequest

JSON Example

{
  "fromEmail": "string",
  "fromName": "string",
  "isDefault": false,
  "isSendShared": false,
  "readSharing": "Private"
}

Used By Operations

PUT Update Email Config
/tenants/{tenant}/email-configs/{code}