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": "d2c2a411-3d4f-4b6d-84b2-25024f4f79d2", "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": "571d1d5c-6d79-4916-a3b6-aec939b5d130", "Teams": [ { "TeamId": "8b1203d6-c3a1-4f30-b555-f06fa483075b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "217335b4-e32c-4c89-aee4-8fa1bed0c972", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "325f91ac-e2ff-433c-b8f9-021d8a83a03e", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "217335b4-e32c-4c89-aee4-8fa1bed0c972", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "325f91ac-e2ff-433c-b8f9-021d8a83a03e", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a4414a45-f3af-446d-989b-1527013b8b5c", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "8b1203d6-c3a1-4f30-b555-f06fa483075b", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "217335b4-e32c-4c89-aee4-8fa1bed0c972", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "325f91ac-e2ff-433c-b8f9-021d8a83a03e", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "217335b4-e32c-4c89-aee4-8fa1bed0c972", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "325f91ac-e2ff-433c-b8f9-021d8a83a03e", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "a4414a45-f3af-446d-989b-1527013b8b5c", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-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": "389b39e1-c59d-4fee-8504-15876e12e3b3", "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": "9681b3b4-fc20-4fd6-9a1b-561e7b9eafea", "Teams": [ { "TeamId": "12a1bf8b-19a5-40b3-99c4-33627ac32e69", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8f3d1737-5b2b-4edd-96a0-dc7b094e1320", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "33508d6f-0ed4-45a0-acba-8e8324aeffc8", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8f3d1737-5b2b-4edd-96a0-dc7b094e1320", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "33508d6f-0ed4-45a0-acba-8e8324aeffc8", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "8cb8eadb-e72f-4521-8286-5f725acf34ce", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "TeamId": "12a1bf8b-19a5-40b3-99c4-33627ac32e69", "Name": "sample string 1", "Description": "sample string 2", "Users": [], "AssetGroups": [ { "AssetGroupId": "8f3d1737-5b2b-4edd-96a0-dc7b094e1320", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "33508d6f-0ed4-45a0-acba-8e8324aeffc8", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" }, { "AssetGroupId": "8f3d1737-5b2b-4edd-96a0-dc7b094e1320", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "MeasurementValueNeededDate": "2025-06-16T13:34:14.611964-07:00", "SourceSystemId": "sample string 3", "CompanyId": "33508d6f-0ed4-45a0-acba-8e8324aeffc8", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" } ], "SourceSystemId": "sample string 3", "CompanyId": "8cb8eadb-e72f-4521-8286-5f725acf34ce", "CreateDate": "2025-06-16T13:34:14.611964-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-16T13:34:14.611964-07:00", "LastModifiedUser": "sample string 6" } ] }, "Total": 1, "Message": "sample string 1" }