ZITADEL Docs
APIsCore ResourcesV1Instance Objects

TestSMTPConfig

Deprecated: Test SMTP Provider

Test an SMTP provider. After testing the provider, the users will receive information about the test results.

Deprecated: please move to the new endpoint TestEmailProviderSMTP.

POST
/smtp/_test

Request Body

application/json

senderAddress*string
senderName*string
tls?boolean
host*string
user?string
password?string
receiverAddress*string
id?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/smtp/_test" \  -H "Content-Type: application/json" \  -d '{    "senderAddress": "string",    "senderName": "string",    "host": "string",    "receiverAddress": "string"  }'
{}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?