Sign in
mail

send test mail to the given recipient

<h3>Administrator send a test e-mail to the given recipient to verify the e-mail configuration</h3>
put/mail/send-test-mail

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/mail/send-test-mail
  • Auth: API key in header Authorization

Request body

mail_addressstring text required

recipient e-mail address

Example request

{
  "name": "member1@example.org"
}

Response

test mail sent

status'success' | 'error' enum required

Whether the sending was a success or an error

textstring text required

A success or an error message

Example response

{
  "status": "success"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.