Invite Operator

POST /engage/sites/invite

This API allows new (or existing) ENGAGE accounts to be invited to an existing SAM managed site. The invited user receives an email at the email address provided in the JSON body of the request, with a link to the ENGAGE portal.

If the user does not have an existing account with ENGAGE they can create their account and it will automatically be linked to the site which was provided in the JSON body of this request. If the user already has an existing account with ENGAGE they can log in with the existing credentials and access to the site will be given based upon the role which was provided in the JSON body of this request.

NOTE: The user that accepts the invite has the option to use a different email address.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

None

Body Parameters

Type: application/json

• Email = string (required)

  • Email that the invite will be sent to. Note: The user that accepts the invite has the option to use a different email address.

• Role = string (required)

  • The type of role that will be included in the invitation. Valid options:

    • “Operator”

    • “Manager”

    • “SiteAdmin”

• SiteReference = string (required)

  • The reference ID of site the invite will be assigned to.

Example Request

POST /engage/sites/invite HTTP/1.1

Host: partner.lockwebserv.com

Content-Type: application/json

Authorization: Basic c2l0ZUFkbWluQHNvZnR3YXJlLmNvbTpFTkdBR0UxMjM0NTY=

{

"Email":"john.smith\@acme.com",

"Role":"Operator",

"SiteReference":"a4ede79c-4348-4617-8aab-a88be1cef4e0"

}

Response

HTTP status code 201

• Created

Body

Type: application/json

• ReferenceID = string

  • Reference ID of the invite.

Example Response

"6b096140-51b2-4560-bf44-ea8d540da67d"