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": "2f1648db-2da7-4032-b621-11ab6b53d248",
"ClubId": "f24c884a-acfd-4e4d-abe1-97cda0c66738",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "347b4eeb-4005-4858-8ccf-1d282d4258b7",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"19eb340b-ed86-4e74-949f-d6788d4218d0",
"4f153141-4cd3-4717-8d51-564c7087dc22"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-01-15T20:56:54.324749+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "2f1648db-2da7-4032-b621-11ab6b53d248",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"2f1648db-2da7-4032-b621-11ab6b53d248","ClubId":"f24c884a-acfd-4e4d-abe1-97cda0c66738","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"347b4eeb-4005-4858-8ccf-1d282d4258b7","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["19eb340b-ed86-4e74-949f-d6788d4218d0","4f153141-4cd3-4717-8d51-564c7087dc22"],"AccountState":7,"LastPasswordChangeOn":"2026-01-15T20:56:54.324749+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"2f1648db-2da7-4032-b621-11ab6b53d248","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">2f1648db-2da7-4032-b621-11ab6b53d248</Id>
<AccountState>7</AccountState>
<ClubId>f24c884a-acfd-4e4d-abe1-97cda0c66738</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-01-15T20:56:54.324749+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>347b4eeb-4005-4858-8ccf-1d282d4258b7</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>2f1648db-2da7-4032-b621-11ab6b53d248</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>19eb340b-ed86-4e74-949f-d6788d4218d0</d2p1:guid>
<d2p1:guid>4f153141-4cd3-4717-8d51-564c7087dc22</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": "2663b900-3e0b-4348-b41d-fec78cb6ae0a",
"ClubId": "3d7aa7bb-504e-4399-aaa1-05d03e7c8928",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "74570fef-b133-4631-b774-0ef2f423c4df",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"53525e68-980f-4351-8826-46215a769f9c",
"a3bf036c-a9b3-4f96-9305-a7882855ab3a"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-01-15T20:56:54.3403705+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "2663b900-3e0b-4348-b41d-fec78cb6ae0a",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"2663b900-3e0b-4348-b41d-fec78cb6ae0a","ClubId":"3d7aa7bb-504e-4399-aaa1-05d03e7c8928","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"74570fef-b133-4631-b774-0ef2f423c4df","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["53525e68-980f-4351-8826-46215a769f9c","a3bf036c-a9b3-4f96-9305-a7882855ab3a"],"AccountState":7,"LastPasswordChangeOn":"2026-01-15T20:56:54.3403705+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"2663b900-3e0b-4348-b41d-fec78cb6ae0a","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">2663b900-3e0b-4348-b41d-fec78cb6ae0a</Id>
<AccountState>7</AccountState>
<ClubId>3d7aa7bb-504e-4399-aaa1-05d03e7c8928</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-01-15T20:56:54.3403705+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>74570fef-b133-4631-b774-0ef2f423c4df</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>2663b900-3e0b-4348-b41d-fec78cb6ae0a</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>53525e68-980f-4351-8826-46215a769f9c</d2p1:guid>
<d2p1:guid>a3bf036c-a9b3-4f96-9305-a7882855ab3a</d2p1:guid>
</UserRoleIds>
</UserDetails>