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": "559ec697-d86d-4762-85d1-80e5691f6b17", "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": "96609ab0-412d-40f6-9ce7-cf4c5453c564", "Teams": [ { "TeamId": "bb68dca2-d87c-4839-b937-55e2d58f3795", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0060edcb-b3ec-4ea8-90c8-3b5b1bacdf0c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b9cbe92-dfcb-49db-988b-d41f3c0ff7f3", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0060edcb-b3ec-4ea8-90c8-3b5b1bacdf0c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b9cbe92-dfcb-49db-988b-d41f3c0ff7f3", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0763caa0-c6d8-4329-87e7-45eb11610523", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "bb68dca2-d87c-4839-b937-55e2d58f3795", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "0060edcb-b3ec-4ea8-90c8-3b5b1bacdf0c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b9cbe92-dfcb-49db-988b-d41f3c0ff7f3", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "0060edcb-b3ec-4ea8-90c8-3b5b1bacdf0c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8488266-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7b9cbe92-dfcb-49db-988b-d41f3c0ff7f3", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "0763caa0-c6d8-4329-87e7-45eb11610523", "CreateDate": "2025-07-31T03:15:12.8488266-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8488266-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": "6eeff9cd-4ae0-4dd4-a0d0-d999edc010a1", "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": "8a95972f-a7b8-4da1-b185-cd6d18ca3b84", "Teams": [ { "TeamId": "de4a3da1-11bc-4425-a68a-e82e1bfc4a44", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "39c017b0-403b-4251-8112-10de2b8cfc6a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0ca23e9a-8a81-4985-9069-c79e4403626e", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "39c017b0-403b-4251-8112-10de2b8cfc6a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0ca23e9a-8a81-4985-9069-c79e4403626e", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d430191-2b55-4795-acc3-b0ca945162be", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "de4a3da1-11bc-4425-a68a-e82e1bfc4a44", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "39c017b0-403b-4251-8112-10de2b8cfc6a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0ca23e9a-8a81-4985-9069-c79e4403626e", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "39c017b0-403b-4251-8112-10de2b8cfc6a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "MeasurementValueNeededDate": "2025-07-31T03:15:12.8644282-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0ca23e9a-8a81-4985-9069-c79e4403626e", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "1d430191-2b55-4795-acc3-b0ca945162be", "CreateDate": "2025-07-31T03:15:12.8644282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:15:12.8644282-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }