Send test email REST API

POST

/api/admin/system/mail/test

curl --request POST \
  --url https://app.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

• cookieAuth

Request Body^required

Media typeapplication/json

object

email

string format: email

Example^generated

{
  "email": "hello@example.com"
}

Responses

200

Mail test result

Media typeapplication/json

object

message

string

status

string

Example^generated

{
  "message": "example",
  "status": "example"
}

400

Invalid recipient

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

503

Mailer not configured

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}