PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}/admins/{userId}

Edits certain user account attributes of a site admin.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

userId

The identifier of the admin to modify.

string

Required

URI Sample(s)

PUT
https://unityapi.webrootcloudav.com/service/api/console/gsm/2114-D9CF-E624-4E06-8D76/sites/9c87b9b3-f89c-4201-a732-ecc2f66b4403/admins/a4e9a217-47bf-4adc-8308-8ddd020a1f12

Body Parameters

Information about which values to modify.

Values which are not provided or null in the request body remain unchanged.

EditGSMSiteAdminRequestModel
NameDescriptionTypeAdditional Information
FirstName

If provided, specifies the new value to be set as the user's first name.

The name must be at least 2 characters and not more than 30 characters in length.

string

None.

LastName

If provided, specifies the new value to be set as the user's last name.

The name must be at least 2 characters and not more than 30 characters in length.

string

None.

Sample Request

{
  "FirstName": "John",
  "LastName": null
}                    
<EditGSMSiteAdminRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <FirstName>John</FirstName>
  <LastName i:nil="true" />
</EditGSMSiteAdminRequestModel>                    

Response Information

Resource Description

None. If successful, this API action does not return any data and the response status code will be 204 (No Content).