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": "b5a20b8f-1205-4562-9411-3b4397df7536",
"ClubId": "634de872-e8a7-4286-b21f-d16c82118bfa",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "956c6a95-18d7-4141-a159-4ca3f0a6e929",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"362ce5b5-00cf-4f21-b6cb-c450888b487c",
"d535b311-7ce2-4847-981b-e4a7ba5a6440"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-24T11:09:08.1191211+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "b5a20b8f-1205-4562-9411-3b4397df7536",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"b5a20b8f-1205-4562-9411-3b4397df7536","ClubId":"634de872-e8a7-4286-b21f-d16c82118bfa","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"956c6a95-18d7-4141-a159-4ca3f0a6e929","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["362ce5b5-00cf-4f21-b6cb-c450888b487c","d535b311-7ce2-4847-981b-e4a7ba5a6440"],"AccountState":7,"LastPasswordChangeOn":"2025-12-24T11:09:08.1191211+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"b5a20b8f-1205-4562-9411-3b4397df7536","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">b5a20b8f-1205-4562-9411-3b4397df7536</Id>
<AccountState>7</AccountState>
<ClubId>634de872-e8a7-4286-b21f-d16c82118bfa</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-24T11:09:08.1191211+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>956c6a95-18d7-4141-a159-4ca3f0a6e929</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>b5a20b8f-1205-4562-9411-3b4397df7536</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>362ce5b5-00cf-4f21-b6cb-c450888b487c</d2p1:guid>
<d2p1:guid>d535b311-7ce2-4847-981b-e4a7ba5a6440</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": "0b859d3d-5bc5-45f0-bab0-082a9992c437",
"ClubId": "5ebec2c8-3828-47ac-a680-af19eec697a7",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "51cd65d7-8645-437e-b849-a988ba3dd2da",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"930c50ae-300d-4da3-a945-b17ec9e9311f",
"bde9bcbf-b86d-45e5-995f-0aa96d5366d8"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-12-24T11:09:08.1191211+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "0b859d3d-5bc5-45f0-bab0-082a9992c437",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"0b859d3d-5bc5-45f0-bab0-082a9992c437","ClubId":"5ebec2c8-3828-47ac-a680-af19eec697a7","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"51cd65d7-8645-437e-b849-a988ba3dd2da","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["930c50ae-300d-4da3-a945-b17ec9e9311f","bde9bcbf-b86d-45e5-995f-0aa96d5366d8"],"AccountState":7,"LastPasswordChangeOn":"2025-12-24T11:09:08.1191211+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"0b859d3d-5bc5-45f0-bab0-082a9992c437","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">0b859d3d-5bc5-45f0-bab0-082a9992c437</Id>
<AccountState>7</AccountState>
<ClubId>5ebec2c8-3828-47ac-a680-af19eec697a7</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-12-24T11:09:08.1191211+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>51cd65d7-8645-437e-b849-a988ba3dd2da</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>0b859d3d-5bc5-45f0-bab0-082a9992c437</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>930c50ae-300d-4da3-a945-b17ec9e9311f</d2p1:guid>
<d2p1:guid>bde9bcbf-b86d-45e5-995f-0aa96d5366d8</d2p1:guid>
</UserRoleIds>
</UserDetails>