Skip to main content

Test SMTP Email Provider

POST 
https://$CUSTOM-DOMAIN/admin/v1/email/smtp/_test

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

Request​

Body

required

    senderAddress stringrequired

    Possible values: non-empty and <= 200 characters

    senderName stringrequired

    Possible values: non-empty and <= 200 characters

    tls boolean
    host stringrequired

    Possible values: non-empty and <= 500 characters

    Make sure to include the port.

    user string
    password string
    receiverAddress stringrequired

    Possible values: non-empty and <= 200 characters

    id string

    Zitadel SMTP provider id in case you are not sending the password and want to reuse the stored password

Responses​

A successful response.

Schema

    object

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/email/smtp/_test' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "senderAddress": "noreply@m.zitadel.cloud",
  "senderName": "ZITADEL",
  "tls": true,
  "host": "smtp.postmarkapp.com:587",
  "user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
  "password": "this-is-my-password",
  "receiverAddress": "noreply@m.zitadel.cloud",
  "id": "267191369515139464"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "senderAddress": "noreply@m.zitadel.cloud",
  "senderName": "ZITADEL",
  "tls": true,
  "host": "smtp.postmarkapp.com:587",
  "user": "197f0117-529e-443d-bf6c-0292dd9a02b7",
  "password": "this-is-my-password",
  "receiverAddress": "noreply@m.zitadel.cloud",
  "id": "267191369515139464"
}
ResponseClear

Click the Send API Request button above and see the response here!