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": "491e3e0b-2d83-4fb0-bde2-b72e372d340a", "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": "5368d299-2ec8-4521-81df-742d6fb3e4fe", "Teams": [ { "TeamId": "01f05160-11e2-4fff-98bb-69c16db285cb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "aaacf3ae-44ed-4a2a-827e-a4618333d456", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b77dd0cc-18ed-429e-9757-47c4015cf51d", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "aaacf3ae-44ed-4a2a-827e-a4618333d456", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b77dd0cc-18ed-429e-9757-47c4015cf51d", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "185e79d4-5306-4c63-8801-a39785a05fa7", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "01f05160-11e2-4fff-98bb-69c16db285cb", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "aaacf3ae-44ed-4a2a-827e-a4618333d456", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b77dd0cc-18ed-429e-9757-47c4015cf51d", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "aaacf3ae-44ed-4a2a-827e-a4618333d456", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b77dd0cc-18ed-429e-9757-47c4015cf51d", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "185e79d4-5306-4c63-8801-a39785a05fa7", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-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": "a7a1fbbd-d36f-43ab-ba8a-bacfff9ffce8", "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": "d3fdb13c-0a58-4eb3-aeb9-cf6c1ba3658b", "Teams": [ { "TeamId": "0dc596bf-0776-4bb4-afcf-3458df1e6b41", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ce34e1c1-93b4-4bf0-9236-837876753fc8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "24a9dc4f-ee2a-44f6-8a98-d671e232b74c", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ce34e1c1-93b4-4bf0-9236-837876753fc8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "24a9dc4f-ee2a-44f6-8a98-d671e232b74c", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e365a118-d492-428b-ac9e-8020981e75bf", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "0dc596bf-0776-4bb4-afcf-3458df1e6b41", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "ce34e1c1-93b4-4bf0-9236-837876753fc8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "24a9dc4f-ee2a-44f6-8a98-d671e232b74c", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "ce34e1c1-93b4-4bf0-9236-837876753fc8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "MeasurementValueNeededDate": "2025-09-13T21:03:20.5601299-07:00", "SourceSystemId": "sample string 3", "CompanyId": "24a9dc4f-ee2a-44f6-8a98-d671e232b74c", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "e365a118-d492-428b-ac9e-8020981e75bf", "CreateDate": "2025-09-13T21:03:20.5601299-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:03:20.5601299-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }