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": "043ef094-7b50-4cf0-9694-5b34777c55d4",
"ClubId": "c8222513-ebf5-4535-9f31-7f1f3e05bd31",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "9c49aec9-74ee-46ba-9640-49ce0afb2bde",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"651658d9-d99a-4844-b2ea-64c7693ae91e",
"7c08ce6c-0f6f-4e07-8736-9455206fa0e3"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-27T18:39:40.1051318+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "043ef094-7b50-4cf0-9694-5b34777c55d4",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"043ef094-7b50-4cf0-9694-5b34777c55d4","ClubId":"c8222513-ebf5-4535-9f31-7f1f3e05bd31","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"9c49aec9-74ee-46ba-9640-49ce0afb2bde","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["651658d9-d99a-4844-b2ea-64c7693ae91e","7c08ce6c-0f6f-4e07-8736-9455206fa0e3"],"AccountState":7,"LastPasswordChangeOn":"2025-11-27T18:39:40.1051318+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"043ef094-7b50-4cf0-9694-5b34777c55d4","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">043ef094-7b50-4cf0-9694-5b34777c55d4</Id>
<AccountState>7</AccountState>
<ClubId>c8222513-ebf5-4535-9f31-7f1f3e05bd31</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-27T18:39:40.1051318+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>9c49aec9-74ee-46ba-9640-49ce0afb2bde</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>043ef094-7b50-4cf0-9694-5b34777c55d4</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>651658d9-d99a-4844-b2ea-64c7693ae91e</d2p1:guid>
<d2p1:guid>7c08ce6c-0f6f-4e07-8736-9455206fa0e3</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": "c9794b1c-f19c-4101-bcdb-7f4bd749f7b3",
"ClubId": "d7633e68-07c7-4039-806d-f29191c790a7",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "6f6bdb3b-5845-4893-8be0-febf2aee4d81",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"4b25d46d-c3a7-4c12-acfb-1875895626e7",
"536d4610-1a81-420e-8908-8a0b519292ab"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-27T18:39:40.292631+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c9794b1c-f19c-4101-bcdb-7f4bd749f7b3",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c9794b1c-f19c-4101-bcdb-7f4bd749f7b3","ClubId":"d7633e68-07c7-4039-806d-f29191c790a7","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6f6bdb3b-5845-4893-8be0-febf2aee4d81","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["4b25d46d-c3a7-4c12-acfb-1875895626e7","536d4610-1a81-420e-8908-8a0b519292ab"],"AccountState":7,"LastPasswordChangeOn":"2025-11-27T18:39:40.292631+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c9794b1c-f19c-4101-bcdb-7f4bd749f7b3","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">c9794b1c-f19c-4101-bcdb-7f4bd749f7b3</Id>
<AccountState>7</AccountState>
<ClubId>d7633e68-07c7-4039-806d-f29191c790a7</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-27T18:39:40.292631+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>6f6bdb3b-5845-4893-8be0-febf2aee4d81</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c9794b1c-f19c-4101-bcdb-7f4bd749f7b3</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>4b25d46d-c3a7-4c12-acfb-1875895626e7</d2p1:guid>
<d2p1:guid>536d4610-1a81-420e-8908-8a0b519292ab</d2p1:guid>
</UserRoleIds>
</UserDetails>