API Docs / Operations / Email Configs / Test Email Config

Test Email Config

POST /tenants/{tenant}/email-configs/{code}/test

Sends a test email through the connection. A failure to send is reported in the result, not as an error.

Parameters

NameTypeDescription
tenant* path string

The tenant code (the organisation's URL stub)

The tenant code (the organisation's URL stub)

code* path string

Request Body*

{
  "recipientEmail": "user@example.com"
}

Responses

400 Bad Request
application/problem+json
401 Unauthorized – Invalid or missing API key
404 Not Found
application/problem+json