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": "ede02573-3f83-4937-9e31-783ef5f0e29b", "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": "87d6e73c-efdd-47ba-8e98-b53d71569684", "Teams": [ { "TeamId": "36233e3a-e8c0-4f2d-8d3f-7e5d046dd5f2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d35e8d44-572b-4e07-b805-a427ed32ceba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3037700b-1ba1-4a50-8314-8c8aad5db8cf", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d35e8d44-572b-4e07-b805-a427ed32ceba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3037700b-1ba1-4a50-8314-8c8aad5db8cf", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "121bca86-acf7-491a-a318-17fad9ce299e", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "36233e3a-e8c0-4f2d-8d3f-7e5d046dd5f2", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "d35e8d44-572b-4e07-b805-a427ed32ceba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3037700b-1ba1-4a50-8314-8c8aad5db8cf", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "d35e8d44-572b-4e07-b805-a427ed32ceba", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3037700b-1ba1-4a50-8314-8c8aad5db8cf", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "121bca86-acf7-491a-a318-17fad9ce299e", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-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": "5c89bf7d-089d-414e-aaae-c4f4aa4fd94d", "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": "cfb67063-7aa6-4bf0-8fb3-a5ae8043ea96", "Teams": [ { "TeamId": "01e34d5d-f978-4d33-89d7-9e8f9b42a353", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "486549cd-32a8-429a-b95e-97b59b447502", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a710fa6f-2fd8-4c17-88f0-a3e4581f80a4", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "486549cd-32a8-429a-b95e-97b59b447502", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a710fa6f-2fd8-4c17-88f0-a3e4581f80a4", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3517720e-6456-432f-b123-744811deb6db", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "01e34d5d-f978-4d33-89d7-9e8f9b42a353", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "486549cd-32a8-429a-b95e-97b59b447502", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a710fa6f-2fd8-4c17-88f0-a3e4581f80a4", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "486549cd-32a8-429a-b95e-97b59b447502", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "MeasurementValueNeededDate": "2025-10-10T13:56:27.0346737-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a710fa6f-2fd8-4c17-88f0-a3e4581f80a4", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "3517720e-6456-432f-b123-744811deb6db", "CreateDate": "2025-10-10T13:56:27.0346737-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T13:56:27.0346737-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }