Settings

Test custom SMTP settings

Changed on

Verifies the saved SMTP config and optionally sends a test email. Failures return success false with an error message.

post/v3/settings/brand/smtp/test

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/settings/brand/smtp/test
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

teamIdstring
sendTestboolean
testEmailstring

Response

Default Response

successboolean
errorstring

Changes

    • breaking

      added required request body

    • info

      api tag Settings added

    • info

      added the media type application/json for the response with the status