POST /api/../InviteEndUser

This request will issue an invitation to a specific user, to use an environment specified by the environment policy.
If the specified policy contains multiple blueprints, the request InviteEndUserToBlueprint should be used instead, with the specific blueprint to be used included in the request.

POST /api/v3/invitations/actions/inviteenduser

Request Payload

    "policyId": "POLs3J1NEAESn7ipYMwYq20Q2",
    "blueprintId": "BPitsTtiUS27hEsHcVZcZsxw2",
    "opportunity": "my company inc.",
    "validForDays": 7,
    "email": "",
    "firstName": "Hudson",
    "lastName": "Kaiden",
    "regionId": "REKolD1-ab84YIxODeMGob9A2",
    "inviteeCanSetEmail": true


PolicyId The environment policy invitee will be assigned to
Opportunity The name of the (business) opportunity associated with this user
ValidForDays The number of days the invitation is valid
Email Email of the user to receive the invitation
FirstName Recipient user’s first name
LastName Recipient user’s last name
BlueprintId The id of the Blueprint which the new user will be invited to use
RegionId The Region the Invitation is to be created in. A list of available Regions can be obtained from here. Optional – default region is US East (Miami)
InviteeCanSetEmail A flag indicating whether an end user can set email when accepting the invitation. Optional parameter – default is true

Response examples

    "invitationDetailsUrl": "",
    "acceptInvitationUrl": "",
    "message": "An invitation was sent successfully"