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": "40550385-0b32-4286-8750-1bacc1eb0592", "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": "824d4baa-b28d-4411-820c-313f7c0abb90", "Teams": [ { "TeamId": "8dc99c7b-478a-4263-b0d9-05d4c2c32b45", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ced0bb78-bfd1-4083-ac56-ba9be7e9bea4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d0118f2-e058-4ed6-9890-b753f47c8fd3", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ced0bb78-bfd1-4083-ac56-ba9be7e9bea4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d0118f2-e058-4ed6-9890-b753f47c8fd3", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fc856db1-0c61-497e-8635-15abcd118974", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8dc99c7b-478a-4263-b0d9-05d4c2c32b45", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ced0bb78-bfd1-4083-ac56-ba9be7e9bea4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d0118f2-e058-4ed6-9890-b753f47c8fd3", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ced0bb78-bfd1-4083-ac56-ba9be7e9bea4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7d0118f2-e058-4ed6-9890-b753f47c8fd3", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "fc856db1-0c61-497e-8635-15abcd118974", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-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": "e6a1344b-9e8b-4153-94d5-b5d1fac53130", "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": "d1b2b224-52de-4f9a-ab12-25fceafdd0cb", "Teams": [ { "TeamId": "72cd13c5-8d2e-4d19-a001-41eeef022d8e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e8dd8aa1-df7e-4914-9bc8-53be62de1ac6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d85b5635-97b9-4ca7-a9a6-9bc9da3986f5", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e8dd8aa1-df7e-4914-9bc8-53be62de1ac6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d85b5635-97b9-4ca7-a9a6-9bc9da3986f5", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bedfd90a-a4db-4861-b10b-eb1a2a03c4d1", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "72cd13c5-8d2e-4d19-a001-41eeef022d8e", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "e8dd8aa1-df7e-4914-9bc8-53be62de1ac6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d85b5635-97b9-4ca7-a9a6-9bc9da3986f5", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "e8dd8aa1-df7e-4914-9bc8-53be62de1ac6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "MeasurementValueNeededDate": "2025-06-02T14:50:59.1084907-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d85b5635-97b9-4ca7-a9a6-9bc9da3986f5", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "bedfd90a-a4db-4861-b10b-eb1a2a03c4d1", "CreateDate": "2025-06-02T14:50:59.1084907-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:50:59.1084907-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }