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": "3a45bfa6-4034-47a0-b128-9ca54e6b655f",
"ClubId": "bbf3899b-9940-4538-ae07-49c858f5aadc",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "ca5b878c-e2a5-45d4-a721-411914bb6d56",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"9ddebf2c-3824-43dd-a08f-d5fdaaa6a804",
"0e568804-d8fd-4f63-9ea7-eae0b96df6a9"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-01T06:46:26.1256611+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "3a45bfa6-4034-47a0-b128-9ca54e6b655f",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"3a45bfa6-4034-47a0-b128-9ca54e6b655f","ClubId":"bbf3899b-9940-4538-ae07-49c858f5aadc","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"ca5b878c-e2a5-45d4-a721-411914bb6d56","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["9ddebf2c-3824-43dd-a08f-d5fdaaa6a804","0e568804-d8fd-4f63-9ea7-eae0b96df6a9"],"AccountState":7,"LastPasswordChangeOn":"2025-12-01T06:46:26.1256611+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"3a45bfa6-4034-47a0-b128-9ca54e6b655f","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">3a45bfa6-4034-47a0-b128-9ca54e6b655f</Id>
<AccountState>7</AccountState>
<ClubId>bbf3899b-9940-4538-ae07-49c858f5aadc</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-01T06:46:26.1256611+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>ca5b878c-e2a5-45d4-a721-411914bb6d56</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>3a45bfa6-4034-47a0-b128-9ca54e6b655f</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>9ddebf2c-3824-43dd-a08f-d5fdaaa6a804</d2p1:guid>
<d2p1:guid>0e568804-d8fd-4f63-9ea7-eae0b96df6a9</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": "ea5a8fee-7bbd-40a6-8306-c685ff46a9e2",
"ClubId": "6ddc4918-d3d1-46a4-b241-e0041ce755e3",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "e76073d1-4c5e-4ee6-b39d-282b86faa24a",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"14fd09ec-1f01-4b30-8cba-1418aec1896c",
"04b67c38-749b-4aa1-b6a0-db79dc4e34c6"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-01T06:46:26.1256611+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "ea5a8fee-7bbd-40a6-8306-c685ff46a9e2",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"ea5a8fee-7bbd-40a6-8306-c685ff46a9e2","ClubId":"6ddc4918-d3d1-46a4-b241-e0041ce755e3","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"e76073d1-4c5e-4ee6-b39d-282b86faa24a","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["14fd09ec-1f01-4b30-8cba-1418aec1896c","04b67c38-749b-4aa1-b6a0-db79dc4e34c6"],"AccountState":7,"LastPasswordChangeOn":"2025-12-01T06:46:26.1256611+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"ea5a8fee-7bbd-40a6-8306-c685ff46a9e2","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">ea5a8fee-7bbd-40a6-8306-c685ff46a9e2</Id>
<AccountState>7</AccountState>
<ClubId>6ddc4918-d3d1-46a4-b241-e0041ce755e3</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-01T06:46:26.1256611+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>e76073d1-4c5e-4ee6-b39d-282b86faa24a</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>ea5a8fee-7bbd-40a6-8306-c685ff46a9e2</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>14fd09ec-1f01-4b30-8cba-1418aec1896c</d2p1:guid>
<d2p1:guid>04b67c38-749b-4aa1-b6a0-db79dc4e34c6</d2p1:guid>
</UserRoleIds>
</UserDetails>