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": "69e273a2-17f0-4f11-8195-1415da510195", "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": "a0317e86-c0cd-4221-8407-0e54b8f32711", "Teams": [ { "TeamId": "19836be4-2de6-4bad-b035-08eaefe2d1bf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "edc94134-72a8-4080-9ed7-1447e2a17dcc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85fe0c4d-1f15-4df3-8a25-d973d5d7d5fe", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "edc94134-72a8-4080-9ed7-1447e2a17dcc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85fe0c4d-1f15-4df3-8a25-d973d5d7d5fe", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0b4e856-858d-4bce-a7f7-933f683693ff", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "19836be4-2de6-4bad-b035-08eaefe2d1bf", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "edc94134-72a8-4080-9ed7-1447e2a17dcc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85fe0c4d-1f15-4df3-8a25-d973d5d7d5fe", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "edc94134-72a8-4080-9ed7-1447e2a17dcc", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2345944-07:00", "SourceSystemId": "sample string 3", "CompanyId": "85fe0c4d-1f15-4df3-8a25-d973d5d7d5fe", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e0b4e856-858d-4bce-a7f7-933f683693ff", "CreateDate": "2025-09-16T23:37:34.2345944-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2345944-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": "5f9333df-2b25-446b-85f2-2ed7e780db3d", "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": "d4e52198-de27-47db-85d8-972ed2e98873", "Teams": [ { "TeamId": "51665401-07b7-460a-bfe9-b8e07e16c8cd", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "56b10f9a-a95c-4211-bf59-a7706c6b6c66", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6f4f2e6d-15c0-498c-9daa-3751d7b71c96", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "56b10f9a-a95c-4211-bf59-a7706c6b6c66", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6f4f2e6d-15c0-498c-9daa-3751d7b71c96", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "893a7452-938e-4732-ab6e-b4b532d9bb49", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "51665401-07b7-460a-bfe9-b8e07e16c8cd", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "56b10f9a-a95c-4211-bf59-a7706c6b6c66", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6f4f2e6d-15c0-498c-9daa-3751d7b71c96", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "56b10f9a-a95c-4211-bf59-a7706c6b6c66", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "MeasurementValueNeededDate": "2025-09-16T23:37:34.2502208-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6f4f2e6d-15c0-498c-9daa-3751d7b71c96", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "893a7452-938e-4732-ab6e-b4b532d9bb49", "CreateDate": "2025-09-16T23:37:34.2502208-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T23:37:34.2502208-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }