PUT Users
Updates the given user.
Request Information
URI Parameters
None.
Body Parameters
User to be updated
UserName | Description | Type | Additional information |
---|---|---|---|
UserId | globally unique identifier |
None. |
|
UserName | string |
None. |
|
FullName | string |
None. |
|
PhoneNumber | string |
None. |
|
string |
None. |
||
IsLockedOut | boolean |
None. |
|
IsApproved | boolean |
None. |
|
Role | Role |
None. |
|
CompanyId | globally unique identifier |
None. |
|
Teams | Collection of Team |
None. |
Request Formats
application/json, text/json
Sample:
{ "UserId": "5d6eeb70-5486-4b60-998a-35444f9c3e84", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "a215d063-09c2-4c31-ba3f-44e7a7cbe730", "Teams": [ { "TeamId": "c4fc2956-b2cb-424f-923b-596e9d53c308", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3382c257-ef47-49f4-af30-fc969bc67ca9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fcc4be5a-0990-4863-a132-9430beaf98c0", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3382c257-ef47-49f4-af30-fc969bc67ca9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fcc4be5a-0990-4863-a132-9430beaf98c0", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d5ad938c-104f-4468-a7b3-264f17417b33", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "c4fc2956-b2cb-424f-923b-596e9d53c308", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "3382c257-ef47-49f4-af30-fc969bc67ca9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fcc4be5a-0990-4863-a132-9430beaf98c0", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "3382c257-ef47-49f4-af30-fc969bc67ca9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fcc4be5a-0990-4863-a132-9430beaf98c0", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "d5ad938c-104f-4468-a7b3-264f17417b33", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ] }
Response Information
Resource Description
On success, the updated user.
Name | Description | Type | Additional information |
---|---|---|---|
Data | User |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "UserId": "ae429fbe-0b1c-4101-ac1f-4951a0b80692", "UserName": "sample string 1", "FullName": "sample string 2", "PhoneNumber": "sample string 3", "Email": "sample string 4", "IsLockedOut": true, "IsApproved": true, "Role": { "Name": "sample string 1", "Description": "sample string 2" }, "CompanyId": "a150ec7f-5786-46a3-b9be-8f2d365a4290", "Teams": [ { "TeamId": "8be7486d-fe95-4735-ad08-bfc416d72562", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d6db94ca-45b2-4650-9cd0-8622613849df", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "30707441-64bb-4bb4-be33-ec5fe9586352", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d6db94ca-45b2-4650-9cd0-8622613849df", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "30707441-64bb-4bb4-be33-ec5fe9586352", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7bcec6b9-ad87-446b-ab8c-d64811573981", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8be7486d-fe95-4735-ad08-bfc416d72562", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d6db94ca-45b2-4650-9cd0-8622613849df", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "30707441-64bb-4bb4-be33-ec5fe9586352", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d6db94ca-45b2-4650-9cd0-8622613849df", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "MeasurementValueNeededDate": "2025-08-30T12:54:18.5980255-07:00", "SourceSystemId": "sample string 3", "CompanyId": "30707441-64bb-4bb4-be33-ec5fe9586352", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "7bcec6b9-ad87-446b-ab8c-d64811573981", "CreateDate": "2025-08-30T12:54:18.5980255-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:54:18.5980255-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }