Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Send Welcome Letter to a Company or Department

You can send a welcome or registration letter to a company or department with the specified ID or instanceUid.


To send a letter to a company or department, send the POST HTTPS request to the URL of the /Tenants/{ID}/action  or /Tenants/{instanceUid}/action resource.

HTTP Request

POST https://<Availability-Console>:1281/v2/Tenants/{ID}/action


POST https://<Availability-Console>:1281/v2/Tenants/{instanceUid}/action

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

In the request body, the client must send the sendWelcomeLetter action property with the null value, for example:

{"sendWelcomeLetter": null}


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a message for an action.

Example Send Welcome Letter to a Company or Department

The following example returns a response on a sendWelcomeLetter action for a tenant with ID 8.


POST https://localhost:1281/v2/Tenants/8/action


Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>


Request Body:

{"sendWelcomeLetter": null}


Response Code:

200 Success


Response Body:

"Welcome email has been sent to the company administrator."

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference