PUT api/v1/users/{userId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userId | globally unique identifier |
Required |
Body Parameters
UserDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| ClubId | globally unique identifier |
Required |
|
| FriendlyName | string |
Required String length: inclusive between 0 and 100 |
|
| NotificationEmail | string |
Required String length: inclusive between 0 and 256 |
|
| PersonId | globally unique identifier |
None. |
|
| Remarks | string |
None. |
|
| UserName | string |
Required String length: inclusive between 0 and 256 |
|
| UserRoleIds | Collection of globally unique identifier |
None. |
|
| AccountState | integer |
None. |
|
| LastPasswordChangeOn | date |
None. |
|
| ForcePasswordChangeNextLogon | boolean |
None. |
|
| EmailConfirmed | boolean |
None. |
|
| LanguageId | integer |
None. |
|
| Id | globally unique identifier |
None. |
|
| CanUpdateRecord | boolean |
None. |
|
| CanDeleteRecord | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062",
"ClubId": "66328010-e079-453f-a5d9-dab6acd3fd2b",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "5a792895-31fe-439d-97b8-53b38399031b",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"73c2e6f9-52d0-4c9d-a3da-da85d7ec5ffe",
"7400b860-11ab-463c-a46e-8632bba1bff7"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-28T18:42:34.9020061+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062","ClubId":"66328010-e079-453f-a5d9-dab6acd3fd2b","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5a792895-31fe-439d-97b8-53b38399031b","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["73c2e6f9-52d0-4c9d-a3da-da85d7ec5ffe","7400b860-11ab-463c-a46e-8632bba1bff7"],"AccountState":7,"LastPasswordChangeOn":"2025-11-28T18:42:34.9020061+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<UserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
<CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
<CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
<Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062</Id>
<AccountState>7</AccountState>
<ClubId>66328010-e079-453f-a5d9-dab6acd3fd2b</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-28T18:42:34.9020061+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>5a792895-31fe-439d-97b8-53b38399031b</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>74d91e6f-fbbf-4e5b-bec0-1b95e4cb6062</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>73c2e6f9-52d0-4c9d-a3da-da85d7ec5ffe</d2p1:guid>
<d2p1:guid>7400b860-11ab-463c-a46e-8632bba1bff7</d2p1:guid>
</UserRoleIds>
</UserDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| ClubId | globally unique identifier |
Required |
|
| FriendlyName | string |
Required String length: inclusive between 0 and 100 |
|
| NotificationEmail | string |
Required String length: inclusive between 0 and 256 |
|
| PersonId | globally unique identifier |
None. |
|
| Remarks | string |
None. |
|
| UserName | string |
Required String length: inclusive between 0 and 256 |
|
| UserRoleIds | Collection of globally unique identifier |
None. |
|
| AccountState | integer |
None. |
|
| LastPasswordChangeOn | date |
None. |
|
| ForcePasswordChangeNextLogon | boolean |
None. |
|
| EmailConfirmed | boolean |
None. |
|
| LanguageId | integer |
None. |
|
| Id | globally unique identifier |
None. |
|
| CanUpdateRecord | boolean |
None. |
|
| CanDeleteRecord | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserId": "9b58a655-d990-4593-943c-33eddcd58030",
"ClubId": "ff9d9b28-24b1-4fe3-b690-0801738ed094",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "02ce8d54-2ca6-4b53-a131-8e20c2acc85c",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"aa352dc0-4e04-422b-9431-498160ff4df2",
"5a2e21ab-600c-4fbe-9355-f881c904a707"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-28T18:42:34.9020061+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "9b58a655-d990-4593-943c-33eddcd58030",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"9b58a655-d990-4593-943c-33eddcd58030","ClubId":"ff9d9b28-24b1-4fe3-b690-0801738ed094","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"02ce8d54-2ca6-4b53-a131-8e20c2acc85c","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["aa352dc0-4e04-422b-9431-498160ff4df2","5a2e21ab-600c-4fbe-9355-f881c904a707"],"AccountState":7,"LastPasswordChangeOn":"2025-11-28T18:42:34.9020061+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"9b58a655-d990-4593-943c-33eddcd58030","CanUpdateRecord":true,"CanDeleteRecord":true}
application/xml, text/xml
Sample:
<UserDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.User">
<CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
<CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
<Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">9b58a655-d990-4593-943c-33eddcd58030</Id>
<AccountState>7</AccountState>
<ClubId>ff9d9b28-24b1-4fe3-b690-0801738ed094</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-28T18:42:34.9020061+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>02ce8d54-2ca6-4b53-a131-8e20c2acc85c</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>9b58a655-d990-4593-943c-33eddcd58030</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>aa352dc0-4e04-422b-9431-498160ff4df2</d2p1:guid>
<d2p1:guid>5a2e21ab-600c-4fbe-9355-f881c904a707</d2p1:guid>
</UserRoleIds>
</UserDetails>