Update Site

PUT /engage/sites/{siteReference}

This API allows the authorized site account to update the name of the site. Typically this would be the site name that is displayed in the ENGAGE mobile app and should reflect the partner system’s site name.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

siteReference = string (required)

• Reference ID of the site

Body Parameters

Type: application/json

• Name = string (required)

  • The desired name change

• IsEngageManaged = boolean (optional)

Example Request

PUT /engage/sites/28bf5e95-bc41-4462-8623-9d26be7e3c35 HTTP/1.1

Host: partner.lockwebserv.com

Content-Type: application/json

Authorization: Basic c2l0ZUFkbWluQHNvZnR3YXJlLmNvbTpFTkdBR0UxMjM0NTY=

{

"Name": "New Name",

”IsEngageManaged”: false

}

Response

HTTP status code 200

• OK – site name successfully changed

Body

Type: application/json

Response Parameters

Type: application/json

• siteReference = string (required)

  • Reference ID of the site

• Name = string (required)

  • The desired name change

• IsEngageManaged = string

Example

{

"SiteReference": "28bf5e95-bc41-4462-8623-9d26be7e3c35",

"Name": "New Name",

"IsEngageManaged": "false"

}