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": "d946bdc1-dff5-4b63-83b4-389868e68192",
"ClubId": "3bf65b3c-9f75-46a2-9753-3b67269f6fd4",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "5c061afe-20bd-4d41-93f6-4d5b079922f0",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"24fbf323-6e91-40ad-b0cb-e3f6cad2bb43",
"bf4077b8-8fb9-4eb2-8005-ecba4777e8a2"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-04T04:34:13.1269472+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "d946bdc1-dff5-4b63-83b4-389868e68192",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"d946bdc1-dff5-4b63-83b4-389868e68192","ClubId":"3bf65b3c-9f75-46a2-9753-3b67269f6fd4","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5c061afe-20bd-4d41-93f6-4d5b079922f0","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["24fbf323-6e91-40ad-b0cb-e3f6cad2bb43","bf4077b8-8fb9-4eb2-8005-ecba4777e8a2"],"AccountState":7,"LastPasswordChangeOn":"2026-02-04T04:34:13.1269472+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"d946bdc1-dff5-4b63-83b4-389868e68192","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">d946bdc1-dff5-4b63-83b4-389868e68192</Id>
<AccountState>7</AccountState>
<ClubId>3bf65b3c-9f75-46a2-9753-3b67269f6fd4</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-04T04:34:13.1269472+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>5c061afe-20bd-4d41-93f6-4d5b079922f0</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>d946bdc1-dff5-4b63-83b4-389868e68192</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>24fbf323-6e91-40ad-b0cb-e3f6cad2bb43</d2p1:guid>
<d2p1:guid>bf4077b8-8fb9-4eb2-8005-ecba4777e8a2</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": "9a664b90-b908-49e9-a9fe-1d1748a7369a",
"ClubId": "d68a2620-6727-4406-b094-4093dabb2ddb",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "4a18fcd2-5b7c-4715-b887-f0cc8a3d263c",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"f8bd34ea-db52-4185-899a-b0a4d08f40d7",
"29ccc0ed-adf4-4e26-b3cc-dc239c75db59"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-04T04:34:13.1269472+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "9a664b90-b908-49e9-a9fe-1d1748a7369a",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"9a664b90-b908-49e9-a9fe-1d1748a7369a","ClubId":"d68a2620-6727-4406-b094-4093dabb2ddb","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4a18fcd2-5b7c-4715-b887-f0cc8a3d263c","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["f8bd34ea-db52-4185-899a-b0a4d08f40d7","29ccc0ed-adf4-4e26-b3cc-dc239c75db59"],"AccountState":7,"LastPasswordChangeOn":"2026-02-04T04:34:13.1269472+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"9a664b90-b908-49e9-a9fe-1d1748a7369a","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">9a664b90-b908-49e9-a9fe-1d1748a7369a</Id>
<AccountState>7</AccountState>
<ClubId>d68a2620-6727-4406-b094-4093dabb2ddb</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-04T04:34:13.1269472+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>4a18fcd2-5b7c-4715-b887-f0cc8a3d263c</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>9a664b90-b908-49e9-a9fe-1d1748a7369a</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f8bd34ea-db52-4185-899a-b0a4d08f40d7</d2p1:guid>
<d2p1:guid>29ccc0ed-adf4-4e26-b3cc-dc239c75db59</d2p1:guid>
</UserRoleIds>
</UserDetails>