Send test email
POST
/api/admin/system/mail/test
const url = 'https://hitkeep.com/api/admin/system/mail/test';const options = { method: 'POST', headers: {cookie: 'hk_token=<hk_token>', 'Content-Type': 'application/json'}, body: '{"email":"hello@example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://hitkeep.com/api/admin/system/mail/test \ --header 'Content-Type: application/json' \ --cookie hk_token=<hk_token> \ --data '{ "email": "hello@example.com" }'Sends a real test email to the specified recipient using the configured mail transport. Writes an instance audit log entry with the actor and outcome.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ” Media type application/json
object
email
string format: email
Example generated
{ "email": "hello@example.com"}Responses
Section titled “ Responses ”Mail test result
Media type application/json
object
message
string
status
string
Example generated
{ "message": "example", "status": "example"}Invalid recipient
Media type application/json
object
message
string
Example generated
{ "message": "example"}Mailer not configured
Media type application/json
object
message
string
Example generated
{ "message": "example"}