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": "2de02f80-98b5-4747-a9cb-1272f276314a", "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": "9f8df9fa-2a18-450c-9ef1-db768a473edf", "Teams": [ { "TeamId": "ca650f38-ea73-40f4-899f-00d82c45c7f1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "533126a2-6caf-4b69-ba08-767211d150ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b2ecf60f-fd3d-45a6-8d44-1fb6d98d4dc8", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "533126a2-6caf-4b69-ba08-767211d150ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b2ecf60f-fd3d-45a6-8d44-1fb6d98d4dc8", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "972d0c2c-937a-47e2-92cd-f075f2db7be9", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "ca650f38-ea73-40f4-899f-00d82c45c7f1", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "533126a2-6caf-4b69-ba08-767211d150ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b2ecf60f-fd3d-45a6-8d44-1fb6d98d4dc8", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "533126a2-6caf-4b69-ba08-767211d150ee", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b2ecf60f-fd3d-45a6-8d44-1fb6d98d4dc8", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "972d0c2c-937a-47e2-92cd-f075f2db7be9", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-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": "5d356b0d-5382-4360-98ca-062599e7c83a", "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": "505631c8-719d-4a53-8c28-b1889be56f63", "Teams": [ { "TeamId": "d16e7f31-7dee-413d-affe-28b053bbd72e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "beeef4a6-42c2-4d3c-b412-020521c78ef4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "17c579c9-5f73-44bb-a7f5-6391cb736f1a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "beeef4a6-42c2-4d3c-b412-020521c78ef4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "17c579c9-5f73-44bb-a7f5-6391cb736f1a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3ae1d538-67a3-495f-a762-a90e679c4b4a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "d16e7f31-7dee-413d-affe-28b053bbd72e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "beeef4a6-42c2-4d3c-b412-020521c78ef4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "17c579c9-5f73-44bb-a7f5-6391cb736f1a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "beeef4a6-42c2-4d3c-b412-020521c78ef4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "MeasurementValueNeededDate": "2025-05-08T16:17:30.7459467-07:00", "SourceSystemId": "sample string 3", "CompanyId": "17c579c9-5f73-44bb-a7f5-6391cb736f1a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3ae1d538-67a3-495f-a762-a90e679c4b4a", "CreateDate": "2025-05-08T16:17:30.7459467-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T16:17:30.7459467-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }