Test SMTP Email Provider

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

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

Request

Path Parameters

id stringrequired

application/json

Body

required

receiverAddress stringrequired

Possible values: non-empty and <= 200 characters

application/grpc

Body

required

receiverAddress stringrequired

Possible values: non-empty and <= 200 characters

application/grpc-web+proto

Body

required

receiverAddress stringrequired

Possible values: non-empty and <= 200 characters

Responses

200

A successful response.

application/json

Schema

Schema

object

Example (from schema)

{}

application/grpc

Schema

Schema

object

Example (from schema)

{}

application/grpc-web+proto

Schema

Schema

object

Example (from schema)

{}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/email/smtp/:id/_test' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "receiverAddress": "noreply@m.zitadel.cloud"
}'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Parameters

id — pathrequired

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "receiverAddress": "noreply@m.zitadel.cloud"
}

ResponseClear

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