POST api/Account/UpdateRequestorUser
Updates user's information. The role of administrator is required.
Request Information
URI Parameters
None.
Body Parameters
UpdateRequestorUserPostName | Description | Type | Additional information |
---|---|---|---|
UserProviderKey |
(Key) User Id |
string |
None. |
User's email. Recommended so the user can receive email notifications. |
string |
None. |
|
RoleEndUser |
Set true if the user has the EndUser role |
boolean |
None. |
RoleSmartUser |
Set true if the user has the SmartUser role |
boolean |
None. |
RoleOperator |
Set true if the user has the Operator role |
boolean |
None. |
RoleSuperOperator |
Set true if the user has the SuperOperator role |
boolean |
None. |
RoleAdministrator |
Set true if the user has the Administrator role |
boolean |
None. |
CustomerId |
(Optional) Default Customer ID |
integer |
None. |
SetUsersUnassignedTicketsToNewCustomer |
(Optional) Set user's unassigned tickets to new customer from CustomerId property |
boolean |
None. |
CustomerIds |
(Optional) All Customer IDs |
Collection of integer |
None. |
InternalGroupIds |
Internal Group IDs |
Collection of integer |
None. |
OperatorGroupIds |
Operator Group IDs |
Collection of integer |
None. |
Language |
(Optional) Language. If not set, the default RQ language is used. |
LanguageEnum |
None. |
FirstName |
Firstname |
string |
None. |
LastName |
Lastname |
string |
None. |
MiddleName |
Middlename |
string |
None. |
DisplayName |
DisplayName |
string |
None. |
Phones |
Phones |
Collection of string |
None. |
TimeZoneId |
The time zone identifier (TimeZoneInfo.Id Property). |
string |
None. |
AdditionalInformation |
AdditionalInformation for users. |
string |
None. |
CustomFields |
The Custom Fields data. |
Collection of UserCustomFieldData |
None. |
ExternalId |
The External id. |
string |
None. |
ManagerKey |
Id of user's manger. |
string |
None. |
Company |
User's company |
string |
None. |
Department |
User's department |
string |
None. |
Division |
User's division |
string |
None. |
EmployeeId |
User's employee Id |
string |
None. |
Request Formats
application/json, text/json
{ "UserProviderKey": "9467ec46-7ad8-4b94-b7e6-2257834abc82", "Email": "john.doe@domain.com", "RoleEndUser": false, "RoleSmartUser": false, "RoleOperator": true, "RoleSuperOperator": false, "RoleAdministrator": false, "CustomerId": null, "SetUsersUnassignedTicketsToNewCustomer": null, "CustomerIds": null, "InternalGroupIds": null, "OperatorGroupIds": null, "Language": null, "FirstName": "John", "LastName": "Doe", "MiddleName": null, "DisplayName": "John Doe", "Phones": [ "123 456 789" ], "TimeZoneId": "Central Europe Standard Time", "AdditionalInformation": "Everything else", "CustomFields": null, "ExternalId": null, "ManagerKey": null, "Company": null, "Department": null, "Division": null, "EmployeeId": null }
application/xml, text/xml
<UpdateRequestorUserPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts"> <AdditionalInformation>Everything else</AdditionalInformation> <Company i:nil="true" /> <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures" i:nil="true" /> <CustomerId i:nil="true" /> <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Department i:nil="true" /> <DisplayName>John Doe</DisplayName> <Division i:nil="true" /> <Email>john.doe@domain.com</Email> <EmployeeId i:nil="true" /> <ExternalId i:nil="true" /> <FirstName>John</FirstName> <InternalGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Language i:nil="true" /> <LastName>Doe</LastName> <ManagerKey i:nil="true" /> <MiddleName i:nil="true" /> <OperatorGroupIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" /> <Phones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>123 456 789</d2p1:string> </Phones> <RoleAdministrator>false</RoleAdministrator> <RoleEndUser>false</RoleEndUser> <RoleOperator>true</RoleOperator> <RoleSmartUser>false</RoleSmartUser> <RoleSuperOperator>false</RoleSuperOperator> <SetUsersUnassignedTicketsToNewCustomer i:nil="true" /> <TimeZoneId>Central Europe Standard Time</TimeZoneId> <UserProviderKey>9467ec46-7ad8-4b94-b7e6-2257834abc82</UserProviderKey> </UpdateRequestorUserPost>
Response Information
Resource Description
UpdateRequestorUserResultName | Description | Type | Additional information |
---|---|---|---|
LastUpdatedUtc |
Last update time of the User entity. Actually it is the updated user server time. |
date |
None. |
Response Formats
application/json, text/json
{ "LastUpdatedUtc": "2024-12-22T12:04:29.0079644+01:00" }
application/xml, text/xml
<UpdateRequestorUserResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results"> <LastUpdatedUtc>2024-12-22T12:04:29.0079644+01:00</LastUpdatedUtc> </UpdateRequestorUserResult>