Send Welcome Letter to a Company or Department

In this article

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

    Request

    To send a welcome letter to a company, send the POST HTTPS request to the URL of the /tenants/{ID}/sendWelcomeEmail resource.

    Alternatively you can use the /tenants/{ID}/action and /tenants/{instanceUid}/action resources. These resources remain for backward compatibility purposes. We recommend to use the /tenants/{ID}/sendWelcomeEmail resource.

    HTTP Request

    POST https://<hostname>:1281/v2/tenants/{ID}/sendWelcomeEmail

    POST https://<hostname>:1281/v2/tenants/{ID}/action

    POST https://<hostname>:1281/v2/tenants/{instanceUid}/action

    Request Headers

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

    Request Body

    If you decide to use the tenants/{id}/action or tenants/{instanceUid}/action resource you must send the sendWelcomeLetter action property with the null value in the request body:

    {"enable": null}

    Response

    The server returns the following response to the client.

    Response Code

    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 HTTP 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

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

    Example Send Welcome Letter to a Company or Department

    The following example sends welcome letter to a company with ID 8.

    Request:

    POST https://localhost:1281/v2/tenants/8/sendWelcomeEmail

     

    Request Header:

    Content-Type: application/json

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    "Welcome email to a tenant has been sent."

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.