PUT v1/Employees
Update an existing Employee. Note: setting ShopRoles and EmployeeGroups are not supported by this URI. Please use specific URIs to add/remove ShopRoles and EmployeeGroups.
Request Information
URI Parameters
None.
Body Parameters
The EmployeeChanges object
EmployeeChanges| Name | Description | Type | Additional information |
|---|---|---|---|
| Password |
Gets or sets the Password |
string |
Required Max length: 200 |
| PublicAlias |
Gets or sets the PublicAlias |
string |
Max length: 50 |
| TimeZone |
Gets or sets the TimeZone |
string |
Max length: 50 |
| BirthDate |
Gets or sets the BirthDate |
date |
None. |
| Gender |
Gets or sets the Gender |
GenderEnum |
None. |
| EmailAddress |
Gets or sets the EmailAddress |
string |
Max length: 100 |
| JobTitle |
Gets or sets the JobTitle |
string |
Max length: 250 |
| OfficeLocation |
Gets or sets the OfficeLocation |
string |
Max length: 100 |
| MobilePhone |
Gets or sets the MobilePhone |
string |
Max length: 20 |
| Ref1 |
Gets or sets the Reference1 |
string |
Max length: 50 |
| Ref2 |
Gets or sets the Reference2 |
string |
Max length: 50 |
| LoginCount |
Gets or sets the LoginCount |
integer |
Required |
| LoginUserToken |
Gets or sets the LoginUserToken |
string |
Max length: 40 |
| PictureFileId |
Gets or sets the PictureFileId |
integer |
None. |
| ShopRoles |
Gets the ShopRoles |
Collection of EmployeeShopRole |
None. |
| EmployeeGroups |
Gets or sets the EmployeeGroups |
Collection of EmployeeGroup |
None. |
| Id |
Gets or sets the id |
integer |
Required |
| FullName |
Gets or sets the FullName |
string |
Required Max length: 100 |
| Login |
Gets or sets the Login |
string |
Required Max length: 50 |
| Enabled |
Gets or sets the Enabled status |
boolean |
Required |
| ShopOwnerId |
Gets or sets the ShopOwnerId |
integer |
None. |
| ShopOwnerCompanyName |
Gets or sets the ShopOwnerCompanyName |
string |
None. |
| IsAdmin |
Gets or sets the IsAdmin |
boolean |
Required |
| IsShopOwnerAdmin |
Gets or sets the IsShopOwnerAdmin |
boolean |
Required |
| LastLogin |
Gets or sets the LastLogin date and time |
date |
None. |
| PhoneExtension |
Gets or sets the Phone |
string |
Max length: 10 |
| CultureId |
Gets or sets the CultureId |
integer |
None. |
| CultureCode |
Gets or sets the CultureCode |
string |
None. |
Request Formats
application/json, text/json
{
"Password": "sample string 1",
"PublicAlias": "sample string 2",
"TimeZone": "sample string 3",
"BirthDate": "2026-01-11T16:13:34.2056677+01:00",
"Gender": 0,
"EmailAddress": "sample string 4",
"JobTitle": "sample string 5",
"OfficeLocation": "sample string 6",
"MobilePhone": "sample string 7",
"Ref1": "sample string 8",
"Ref2": "sample string 9",
"LoginCount": 10,
"LoginUserToken": "sample string 11",
"PictureFileId": 1,
"ShopRoles": [],
"EmployeeGroups": [],
"Id": 12,
"FullName": "sample string 13",
"Login": "sample string 14",
"Enabled": true,
"ShopOwnerId": 1,
"ShopOwnerCompanyName": "sample string 16",
"IsAdmin": true,
"IsShopOwnerAdmin": true,
"LastLogin": "2026-01-11T16:13:34.2056677+01:00",
"PhoneExtension": "sample string 19",
"CultureId": 1,
"CultureCode": "sample string 20"
}
application/xml, text/xml
<EmployeeChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Id>12</Id> <FullName>sample string 13</FullName> <Login>sample string 14</Login> <Enabled>true</Enabled> <ShopOwnerId>1</ShopOwnerId> <ShopOwnerCompanyName>sample string 16</ShopOwnerCompanyName> <IsAdmin>true</IsAdmin> <IsShopOwnerAdmin>true</IsShopOwnerAdmin> <LastLogin>2026-01-11T16:13:34.2056677+01:00</LastLogin> <PhoneExtension>sample string 19</PhoneExtension> <CultureId>1</CultureId> <CultureCode>sample string 20</CultureCode> <PublicAlias>sample string 2</PublicAlias> <TimeZone>sample string 3</TimeZone> <BirthDate>2026-01-11T16:13:34.2056677+01:00</BirthDate> <Gender>Unknown</Gender> <EmailAddress>sample string 4</EmailAddress> <JobTitle>sample string 5</JobTitle> <OfficeLocation>sample string 6</OfficeLocation> <MobilePhone>sample string 7</MobilePhone> <Ref1>sample string 8</Ref1> <Ref2>sample string 9</Ref2> <LoginCount>10</LoginCount> <LoginUserToken>sample string 11</LoginUserToken> <PictureFileId>1</PictureFileId> <ShopRoles /> <EmployeeGroups /> <Password>sample string 1</Password> </EmployeeChanges>
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |