Organizations

Update the SMTP settings for an organization

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.

patch/v2/organizations/settings/smtp

Request

Base URL
https://api.sigmacomputing.com
Auth
HTTP bearer

Request body

hoststring required

Hostname or IP address of the custom SMTP server.

portstring required

Port of the custom SMTP server, e.g. "587".

usernamestring required

Username used to authenticate with the SMTP server.

senderEmailstring required

Email address that outgoing mail is sent from.

passwordstring required

Password used to authenticate with the SMTP server. This value is never returned.

senderNamestring

Display name that outgoing mail is sent from.

globalBccAddressesstring[]

Email addresses included as default Bcc recipients.

replyToAddressstring email nullable

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

Response

The response body.