InviteCustomer

This resource will issue an invitation to a specific user, to use an environment specified by the usage package.

If the specified usage package contains multiple prototypes, the resource InviteCustomerToPrototype should be used instead, with the specific prototype to be used included in the request.

Request URL

GET https://use.cloudshare.com/Api/v1/Admin/InviteCustomer?usagePackageId=<usage>&opportunity=<opportunity>&validForDays=<valid>&sendToEmail=<sendto>&firstName=<firstname>&lastName=<lastname>&UserApiId=<id>&timestamp=<time_t>&HMAC=<signature>

Parameters

usagePackageId The id for the usage package of the environment
Example: PVSV2TWQQ2BA
Opportunity The name of the (business) opportunity associated with this user
validForDays The number of days the invitation is valid
sendToEmail Email of the user to receive the invitation
firstName Recipient user’s first name
lastName Recipient user’s last name

Response example

{
    "acceptUrl": "https://use.cloudshare.com/Ent/AcceptInvitation.mvc?inv=om7S_CjOZls",
    "detailsUrl":  "https://use.cloudshare.com/Ent/Vendor/InvitationDetails.aspx?
inv=om7S_CjOZls",
    "message": "An invitation was created successfully"
}

The response includes a link to the invitation URL sent to the recipient, and a URL with details for the sender (the vendor).

If the Usage Package contained multiple prototypes, an error status (Invalid Action) will be returned.

Code sample