Sends a test message to a specified email.
Request
To send a test message, send the POST HTTPS request to the URL of the /VEXEmailSettings/Action resource.
HTTPS Request
POST https://<Backup-Office365>:4443/v2/VEXEmailSettings/Action |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
Content-Type: application/json | true | Specifies the type of the content for your request. |
Authorization: Bearer <Access-Token> | true | The request header must contain the authorization token for the current logon session. |
Request Body
To send a test message, the request body must contain the sendTest action properties:
Property | Type | Description |
string | Specifies the email you want to send the test message to. For example, "email": "jsmith@westsupport.onmicrosoft.com". |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
None.
Example
The example below shows how to send a test message to a specified email.
Request: POST https://support.east.local:4443/v2/VEXEmailSettings/Action Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: { "sendTest": { "Email": email@gmail.com } }
Response: 200 OK |
