PUT api/v1/users/{userId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId | globally unique identifier |
Required |
Body Parameters
UserDetailsName | 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": "fe10895b-7b9a-44a1-acab-a0f268adc351", "ClubId": "b582b768-453a-4810-8038-9caec976f937", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "5fabbddd-f591-4e2f-9516-d907b60b9bab", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "dffb99ce-d465-4fb4-af24-63b568ce3e65", "e8834270-8157-4244-898a-272c720ff7ea" ], "AccountState": 7, "LastPasswordChangeOn": "2025-08-30T06:38:30.2010367+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "fe10895b-7b9a-44a1-acab-a0f268adc351", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"fe10895b-7b9a-44a1-acab-a0f268adc351","ClubId":"b582b768-453a-4810-8038-9caec976f937","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5fabbddd-f591-4e2f-9516-d907b60b9bab","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["dffb99ce-d465-4fb4-af24-63b568ce3e65","e8834270-8157-4244-898a-272c720ff7ea"],"AccountState":7,"LastPasswordChangeOn":"2025-08-30T06:38:30.2010367+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"fe10895b-7b9a-44a1-acab-a0f268adc351","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">fe10895b-7b9a-44a1-acab-a0f268adc351</Id> <AccountState>7</AccountState> <ClubId>b582b768-453a-4810-8038-9caec976f937</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-08-30T06:38:30.2010367+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>5fabbddd-f591-4e2f-9516-d907b60b9bab</PersonId> <Remarks>sample string 5</Remarks> <UserId>fe10895b-7b9a-44a1-acab-a0f268adc351</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>dffb99ce-d465-4fb4-af24-63b568ce3e65</d2p1:guid> <d2p1:guid>e8834270-8157-4244-898a-272c720ff7ea</d2p1:guid> </UserRoleIds> </UserDetails>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserDetailsName | 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": "3d06bae0-fb20-4d58-b6a6-3d7aebcffef4", "ClubId": "e57a8a77-15ba-4edb-b658-1b1565da2cc3", "FriendlyName": "sample string 3", "NotificationEmail": "sample string 4", "PersonId": "5c4860f0-a82c-471f-b5a3-a5358e35d8cd", "Remarks": "sample string 5", "UserName": "sample string 6", "UserRoleIds": [ "9a4beae9-1907-4ae1-a183-375257749f97", "bd75aef1-0b73-4dcd-a801-c9daf66f0dac" ], "AccountState": 7, "LastPasswordChangeOn": "2025-08-30T06:38:30.2010367+02:00", "ForcePasswordChangeNextLogon": true, "EmailConfirmed": true, "LanguageId": 10, "Id": "3d06bae0-fb20-4d58-b6a6-3d7aebcffef4", "CanUpdateRecord": true, "CanDeleteRecord": true }
text/html
Sample:
{"UserId":"3d06bae0-fb20-4d58-b6a6-3d7aebcffef4","ClubId":"e57a8a77-15ba-4edb-b658-1b1565da2cc3","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5c4860f0-a82c-471f-b5a3-a5358e35d8cd","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["9a4beae9-1907-4ae1-a183-375257749f97","bd75aef1-0b73-4dcd-a801-c9daf66f0dac"],"AccountState":7,"LastPasswordChangeOn":"2025-08-30T06:38:30.2010367+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"3d06bae0-fb20-4d58-b6a6-3d7aebcffef4","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">3d06bae0-fb20-4d58-b6a6-3d7aebcffef4</Id> <AccountState>7</AccountState> <ClubId>e57a8a77-15ba-4edb-b658-1b1565da2cc3</ClubId> <EmailConfirmed>true</EmailConfirmed> <ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon> <FriendlyName>sample string 3</FriendlyName> <LanguageId>10</LanguageId> <LastPasswordChangeOn>2025-08-30T06:38:30.2010367+02:00</LastPasswordChangeOn> <NotificationEmail>sample string 4</NotificationEmail> <PersonId>5c4860f0-a82c-471f-b5a3-a5358e35d8cd</PersonId> <Remarks>sample string 5</Remarks> <UserId>3d06bae0-fb20-4d58-b6a6-3d7aebcffef4</UserId> <UserName>sample string 6</UserName> <UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>9a4beae9-1907-4ae1-a183-375257749f97</d2p1:guid> <d2p1:guid>bd75aef1-0b73-4dcd-a801-c9daf66f0dac</d2p1:guid> </UserRoleIds> </UserDetails>