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": "d3730a84-5e71-4c98-8827-6a52ba502e1f", "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": "46dc2a18-26b4-4ffe-a3aa-bed80de3d30e", "Teams": [ { "TeamId": "16f26cdf-0835-4898-8d14-c9309fe01d40", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e0e93fac-2f02-4b31-8719-d2b8311590bb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "18498950-ae75-4dc7-8536-ca1995deeaa9", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e0e93fac-2f02-4b31-8719-d2b8311590bb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "18498950-ae75-4dc7-8536-ca1995deeaa9", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e8f860a1-9c38-4882-98a1-58ba13d679ae", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "16f26cdf-0835-4898-8d14-c9309fe01d40", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e0e93fac-2f02-4b31-8719-d2b8311590bb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "18498950-ae75-4dc7-8536-ca1995deeaa9", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e0e93fac-2f02-4b31-8719-d2b8311590bb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "18498950-ae75-4dc7-8536-ca1995deeaa9", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e8f860a1-9c38-4882-98a1-58ba13d679ae", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-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": "8af588c0-83ee-41b0-9a49-d76acecf6af5", "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": "0aa4b357-fe5e-4b4c-b8f1-ca7fbd436624", "Teams": [ { "TeamId": "94152188-58c2-4394-b124-8397b8dfab74", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8f9eebee-8f2e-46e2-9bc1-1552098a39eb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "11902956-909e-4d9a-8b9b-e1c09ac3c589", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8f9eebee-8f2e-46e2-9bc1-1552098a39eb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "11902956-909e-4d9a-8b9b-e1c09ac3c589", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f7711d25-b040-415b-afc6-2176f10b147f", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "94152188-58c2-4394-b124-8397b8dfab74", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8f9eebee-8f2e-46e2-9bc1-1552098a39eb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "11902956-909e-4d9a-8b9b-e1c09ac3c589", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8f9eebee-8f2e-46e2-9bc1-1552098a39eb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "MeasurementValueNeededDate": "2025-07-19T00:08:29.7177636-07:00", "SourceSystemId": "sample string 3", "CompanyId": "11902956-909e-4d9a-8b9b-e1c09ac3c589", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "f7711d25-b040-415b-afc6-2176f10b147f", "CreateDate": "2025-07-19T00:08:29.7177636-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T00:08:29.7177636-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }