SIsigmacomputing
Organizations

Get the SMTP settings for an organization

Get the custom SMTP server configuration 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.
  • If custom SMTP has not been configured for the organization, this endpoint returns a 404.
  • The SMTP password is never returned in the response.
get/v2/organizations/settings/smtp

Request

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

Response

The response 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.

senderNamestring required

Display name that outgoing mail is sent from.

globalBccAddressesstring[] required

Email addresses included as default Bcc recipients.

replyToAddressstring email nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.