POST api/Account/UpdateRequestorUser

Updates user's information. The role of administrator is required.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserProviderKey	(Key) User Id	string	None.
Email	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.
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.
SkypeName	SkypeName	string	None.
TimeZoneId	The time zone identifier (TimeZoneInfo.Id Property).	string	None.
AdminNote	Note about the user, for administrators only.	string	None.
OperatorNote	Note about the user, for operators only.	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

Sample:

{
  "UserProviderKey": "e87ed9af-3ab1-45e8-ba72-e3841f771d2f",
  "Email": "john.doe@domain.com",
  "RoleEndUser": false,
  "RoleSmartUser": false,
  "RoleOperator": true,
  "RoleSuperOperator": false,
  "RoleAdministrator": false,
  "CustomerId": null,
  "CustomerIds": null,
  "InternalGroupIds": null,
  "OperatorGroupIds": null,
  "Language": null,
  "FirstName": "John",
  "LastName": "Doe",
  "MiddleName": null,
  "DisplayName": "John Doe",
  "Phones": [
    "123 456 789"
  ],
  "SkypeName": null,
  "TimeZoneId": "Central Europe Standard Time",
  "AdminNote": "Everything else for admin",
  "OperatorNote": null,
  "AdditionalInformation": "Everything else",
  "CustomFields": null,
  "ExternalId": null,
  "ManagerKey": null,
  "Company": null,
  "Department": null,
  "Division": null,
  "EmployeeId": null
}

application/xml, text/xml

Sample:

<UpdateRequestorUserPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <AdditionalInformation>Everything else</AdditionalInformation>
  <AdminNote>Everything else for admin</AdminNote>
  <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" />
  <OperatorNote 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>
  <SkypeName i:nil="true" />
  <TimeZoneId>Central Europe Standard Time</TimeZoneId>
  <UserProviderKey>e87ed9af-3ab1-45e8-ba72-e3841f771d2f</UserProviderKey>
</UpdateRequestorUserPost>

Response Information

Resource Description

UpdateRequestorUserResult

Name	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

Sample:

{
  "LastUpdatedUtc": "2024-04-28T12:39:58.843753+02:00"
}

application/xml, text/xml

Sample:

<UpdateRequestorUserResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <LastUpdatedUtc>2024-04-28T12:39:58.843753+02:00</LastUpdatedUtc>
</UpdateRequestorUserResult>