Invite an end user to a POC, based on a specified blueprint, and assigns a specific project member user to be the owning project member for the end user.
A policy ID, blueprint ID and owning project member ID must be specified. To retrieve the available relevant IDs, use OPTIONS /api/v3/invitations.
Request Path
POST /api/v3/invitations/actions/invitetopoc
Request Payload
{
"policyId": "POLs3J1NEAESn7ipYMwYq20Q2",
"blueprintId": "BPitsTtiUS27hEsHcVZcZsxw2",
"owningProjectMemberId": "VPvcJta67Wp3TuDw-j4PhAiQ2",
"opportunity": "user opportunity",
"validForDays": 7,
"email": "HudsonKaiden@cloudshare.com",
"firstName": "Hudson",
"lastName": "Kaiden",
"regionId": "REKolD1-ab84YIxODeMGob9A2",
"inviteeCanSetEmail": true,
"customEmailSubject": "email subject",
"customEmailBody": "email body"
}
Parameters
policyId |
The ID of the environment policy to assign to the environment created for the end user as part of the POC. The policy will govern the life cycle of the end user’s environment. |
blueprintId |
The ID of the blueprint based on which the end user’s environment will be created (this is the POC’s blueprint). |
OwningProjectMemberId |
The ID of the project member user to whom the end user will be assigned |
opportunity |
The name of the business opportunity to be associated with the end user |
validForDays |
The number of days to keep the invitation valid for |
email |
The recipient’s email. The invitation will be sent to the specified email. |
firstName |
The recipient’s first name |
LastName |
The recipient’s last name |
regionId |
Optional. The region in which to create the POC’s environment. A list of available regions can be obtained from here. The default region is US East (Miami). |
InviteeCanSetEmail |
Optional. Boolean. Indicates whether an end user can set email when accepting the invitation. Default is true. |
customEmailSubject |
Optional. The subject of the email. The invitation will be sent with the specified custom email subject. This value will override the custom email subject in the UI. |
customEmailBody |
Optional. The body of the email. The invitation will be sent with the specified custom email body. This value will override the custom email body in the UI. |
Response Example
{
"invitationDetailsUrl": "https://use.cloudshare.com/Ent/Vendor/InvitationDetails.aspx?inv=ZEMeSj6RxMU",
"acceptInvitationUrl": "https://use.cloudshare.com/Ent/AcceptInvitation.mvc?inv=ZEMeSj6RxMU",
"message": "An invitation was sent successfully"
}