---
title: "Sends a test email to the provided address with the given custom settings"
method: POST
path: "/SmtpSettings/Test"
tags: ["Rest"]
---

# Sends a test email to the provided address with the given custom settings

`POST /SmtpSettings/Test`

## Query parameters

- `to` string, required

## Headers

- `Authorization` string, required
- `SiteId` integer, required

## Request body

- MindbodyRestApiDtoModelsNotificationsCustomSmtpSettings — Custom SMTP Settings
  - `Host` string — The hostname of the subscriber's SMTP server
  - `Username` string — Username for the provided SMTP server - This should be a valid email address.
  - `Password` MindbodyRestApiDtoModelsNotificationsPassword — A password value that may or may not be encrypted
    - `Encrypted` boolean — Whether or not the password is encrypted
    - `Value` string — Password value
  - `Port` integer — The port used to connect to the specified host - Official SMTP ports per RFC 3207 are 25 for insecure connections and 587 for using the STARTTLS command. Other ports are technically valid but not recommended.
  - `Timeout` integer — The timeout in milliseconds for requests sent to the specified host
  - `Secure` boolean — Whether to use SSL/TLS to secure the connection with the specified host - This option only supports securing the connection via the explicit STARTTLS command which should be performed on port 587. Optional: when omitted on an update the stored value is left as it is, so a caller that does not manage this setting cannot turn TLS off by not mentioning it.

## Response `200`

OK

- MindbodyRestApiDtoModelsNotificationsCustomSmtpSettings — Custom SMTP Settings
  - `Host` string — The hostname of the subscriber's SMTP server
  - `Username` string — Username for the provided SMTP server - This should be a valid email address.
  - `Password` MindbodyRestApiDtoModelsNotificationsPassword — A password value that may or may not be encrypted
    - `Encrypted` boolean — Whether or not the password is encrypted
    - `Value` string — Password value
  - `Port` integer — The port used to connect to the specified host - Official SMTP ports per RFC 3207 are 25 for insecure connections and 587 for using the STARTTLS command. Other ports are technically valid but not recommended.
  - `Timeout` integer — The timeout in milliseconds for requests sent to the specified host
  - `Secure` boolean — Whether to use SSL/TLS to secure the connection with the specified host - This option only supports securing the connection via the explicit STARTTLS command which should be performed on port 587. Optional: when omitted on an update the stored value is left as it is, so a caller that does not manage this setting cannot turn TLS off by not mentioning it.

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden
- `500` — InternalServerError

---

[API](https://skmtc.net/mindbodyonline/apis/rest-api.md) · [All operations](https://skmtc.net/mindbodyonline/apis/rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mindbodyonline/rest-api/revisions/dc2736850e42/schema)