Skip to navigation
Sigma REST APIOrganizationssmtp

Update the SMTP settings for an organization

View as Markdown

Configure the custom SMTP server used to send email on behalf of the organization.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned an account type with the Manage email branding permission enabled.
  • To read or update SMTP settings for a tenant organization, use impersonation to obtain a token for that tenant, then call this endpoint with that token.
  • Sigma tests the connection before saving the settings.
  • Omitted branding fields retain their existing values.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
hoststringRequired
Hostname or IP address of the custom SMTP server.
portstringRequired
Port of the custom SMTP server, e.g. "587".
usernamestringRequired
Username used to authenticate with the SMTP server.
senderEmailstringRequired
Email address that outgoing mail is sent from.
passwordstringRequired
Password used to authenticate with the SMTP server. This value is never returned.
senderNamestringOptional
Display name that outgoing mail is sent from.
globalBccAddresseslist of stringsOptional
Email addresses included as default Bcc recipients.
replyToAddressstring or nullOptionalformat: "email"

Email address that recipients' replies are sent to, or null if unset.

Response

The response body.
hoststring
Hostname or IP address of the custom SMTP server.
portstring
Port of the custom SMTP server, e.g. "587".
usernamestring
Username used to authenticate with the SMTP server.
senderEmailstring
Email address that outgoing mail is sent from.
senderNamestring
Display name that outgoing mail is sent from.
globalBccAddresseslist of strings
Email addresses included as default Bcc recipients.
replyToAddressstring or nullformat: "email"

Email address that recipients' replies are sent to, or null if unset.