> ## Documentation Index
> Fetch the complete documentation index at: https://snowseo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Test SMTP

> Verify the saved SMTP configuration and optionally send a test email.

Verify the saved SMTP configuration by opening a connection, and optionally send a test message.

| Field | Description |
| - | - |
| `teamId` | Brand (team) whose saved config to test. |
| `sendTest` | When `true`, also send a test email after verifying. |
| `testEmail` | Recipient for the test email. Required (and must be valid) when `sendTest` is `true`. |

On success the response is `{ "success": true }`. Failures use the standard [error format](https://snowseo.com/docs/api-reference/introduction.md#response-format):

| Status | `code` | When |
| - | - | - |
| `400` | `SMTP_NOT_CONFIGURED` | No usable SMTP configuration is saved. |
| `400` | `BAD_REQUEST` | `sendTest` is `true` without a valid `testEmail`. |
| `502` | `SMTP_TEST_FAILED` | The server rejected the connection, the login, or the test message. |

The `error` text is a friendly hint: for example, an SSL/TLS mismatch suggests port `465` for SSL or `587` (STARTTLS) for TLS, and an auth error points at the username and password.


## OpenAPI

````yaml POST /v3/settings/brand/smtp/test
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security:
  - bearerAuth: []
  - apiKey: []
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/settings/brand/smtp/test:
    post:
      tags:
        - Settings
      summary: Test custom SMTP settings
      description: >-
        Verifies the saved SMTP config and, with `sendTest`, sends a test email
        to `testEmail`. Bad config or input returns 400, a failed connection or
        send returns 502, both with an error message.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                teamId:
                  type: string
                sendTest:
                  type: boolean
                testEmail:
                  type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  reference:
                    type: string
        '502':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  reference:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your SnowSEO API key (sk_...).
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.