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": "ae35efe3-9f47-482c-8e3d-447acd53b250", "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": "5debac47-cd2f-4805-a103-007b051f62de", "Teams": [ { "TeamId": "d6736269-6a88-43b3-9017-f26f1246d398", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "91e65ec6-41e2-4ebb-886f-8b3c8bc2b708", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c309c281-5d81-4a63-8380-44287dfeda46", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "91e65ec6-41e2-4ebb-886f-8b3c8bc2b708", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c309c281-5d81-4a63-8380-44287dfeda46", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2be3be2b-c6d6-49cd-b8e7-a4be616b6dd5", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d6736269-6a88-43b3-9017-f26f1246d398", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "91e65ec6-41e2-4ebb-886f-8b3c8bc2b708", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c309c281-5d81-4a63-8380-44287dfeda46", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "91e65ec6-41e2-4ebb-886f-8b3c8bc2b708", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c309c281-5d81-4a63-8380-44287dfeda46", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "2be3be2b-c6d6-49cd-b8e7-a4be616b6dd5", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-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": "9e67b646-9a16-461f-84e9-7fe0b51336cb", "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": "43825fe2-79d8-49f5-be96-d47f6a1e9d4f", "Teams": [ { "TeamId": "817fe4b0-1a53-44c0-9038-3900c8efd549", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "77b703d6-924e-4ef0-9690-7bed6355979c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "15c9daeb-915a-4756-8cbf-a20768d5b166", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "77b703d6-924e-4ef0-9690-7bed6355979c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "15c9daeb-915a-4756-8cbf-a20768d5b166", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "98b522ea-309a-4a5d-b3f0-4df3c66d2e7c", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "817fe4b0-1a53-44c0-9038-3900c8efd549", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "77b703d6-924e-4ef0-9690-7bed6355979c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "15c9daeb-915a-4756-8cbf-a20768d5b166", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "77b703d6-924e-4ef0-9690-7bed6355979c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "MeasurementValueNeededDate": "2025-06-22T23:55:09.4719529-07:00", "SourceSystemId": "sample string 3", "CompanyId": "15c9daeb-915a-4756-8cbf-a20768d5b166", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "98b522ea-309a-4a5d-b3f0-4df3c66d2e7c", "CreateDate": "2025-06-22T23:55:09.4719529-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:55:09.4719529-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }