This request will issue an invitation to a specified user, to use the environment specified by the policy. It will also assign this user to a specific Project Member.

If the specified policy contains multiple blueprints, the request InviteEndUserAndAssignProjectMemberToBlueprint should be used instead, with the specific Blueprint to be used included in the request.

Request URL



environmentPolicyId The id for the policy for the environment
opportunity The name of the (business) opportunity associated with this user
Example: Op
validForDays The number of days the invitation is valid
owningProjectMemberId The id of the Project Member for the new environment.
sendToEmail Email of the user to receive the invitation
firstName Recipient user’s first name
lastName Recipient user’s last name

Response example

    "data": {
        "acceptUrl": "", 
        "detailsUrl": "", 
        "message": "An invitation was sent successfully"
    "remaining_api_calls": 94, 
    "status_additional_data": null, 
    "status_code": "0x20000", 
    "status_text": "Success"

If the policy contains multiple Blueprints, an error status (Invalid Action) will be returned.