---
title: "Update the SMTP settings for an organization"
method: PATCH
path: "/v2/organizations/settings/smtp"
tags: ["Organizations"]
---

# Update the SMTP settings for an organization

`PATCH /v2/organizations/settings/smtp`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/organizations/settings/smtp`
- Auth: HTTP bearer

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](/docs/impersonate-users) 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.

## Request body

- object
  - `host` string, required: Hostname or IP address of the custom SMTP server.
  - `port` string, required: Port of the custom SMTP server, e.g. "587".
  - `username` string, required: Username used to authenticate with the SMTP server.
  - `senderEmail` string, required: Email address that outgoing mail is sent from.
  - `password` string, required: Password used to authenticate with the SMTP server. This value is never returned.
  - `senderName` string: Display name that outgoing mail is sent from.
  - `globalBccAddresses` string[]: Email addresses included as default Bcc recipients.
  - `replyToAddress` string, email, nullable: Email address that recipients' replies are sent to, or `null` if unset.

## Response `200`

The response body.

- OrganizationsUpdateSmtpSettingsResponse200
  - `host` string, required: Hostname or IP address of the custom SMTP server.
  - `port` string, required: Port of the custom SMTP server, e.g. "587".
  - `username` string, required: Username used to authenticate with the SMTP server.
  - `senderEmail` string, required: Email address that outgoing mail is sent from.
  - `senderName` string, required: Display name that outgoing mail is sent from.
  - `globalBccAddresses` string[], required: Email addresses included as default Bcc recipients.
  - `replyToAddress` string, email, nullable, required: Email address that recipients' replies are sent to, or `null` if unset.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)