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": "c6e17937-0713-44d3-b075-775116211be7",
"ClubId": "7f73d514-5497-4dcc-b7bc-c337303b5338",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "aef12b50-2b5b-42c2-bf1c-7e6a044b550a",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"6b0eb764-ed0a-4579-9e51-d94545892d95",
"6fc7d73c-5f79-4170-8922-b602e38be9c8"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-03T12:50:24.8641934+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c6e17937-0713-44d3-b075-775116211be7",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c6e17937-0713-44d3-b075-775116211be7","ClubId":"7f73d514-5497-4dcc-b7bc-c337303b5338","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"aef12b50-2b5b-42c2-bf1c-7e6a044b550a","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["6b0eb764-ed0a-4579-9e51-d94545892d95","6fc7d73c-5f79-4170-8922-b602e38be9c8"],"AccountState":7,"LastPasswordChangeOn":"2025-11-03T12:50:24.8641934+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c6e17937-0713-44d3-b075-775116211be7","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">c6e17937-0713-44d3-b075-775116211be7</Id>
<AccountState>7</AccountState>
<ClubId>7f73d514-5497-4dcc-b7bc-c337303b5338</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-03T12:50:24.8641934+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>aef12b50-2b5b-42c2-bf1c-7e6a044b550a</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c6e17937-0713-44d3-b075-775116211be7</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6b0eb764-ed0a-4579-9e51-d94545892d95</d2p1:guid>
<d2p1:guid>6fc7d73c-5f79-4170-8922-b602e38be9c8</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": "aacc378d-3db3-4ada-ad84-ace29d89ee89",
"ClubId": "8d8c05a1-a10e-408a-927e-53edbf4cf6e1",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "6ddf03a6-80b1-42bb-96a2-2cd20c216f20",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"4357f2b6-fa2b-4006-a08b-ebf0c3c3d933",
"909329ef-69cc-439d-9a62-72778a63f629"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-11-03T12:50:24.8641934+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "aacc378d-3db3-4ada-ad84-ace29d89ee89",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"aacc378d-3db3-4ada-ad84-ace29d89ee89","ClubId":"8d8c05a1-a10e-408a-927e-53edbf4cf6e1","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"6ddf03a6-80b1-42bb-96a2-2cd20c216f20","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["4357f2b6-fa2b-4006-a08b-ebf0c3c3d933","909329ef-69cc-439d-9a62-72778a63f629"],"AccountState":7,"LastPasswordChangeOn":"2025-11-03T12:50:24.8641934+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"aacc378d-3db3-4ada-ad84-ace29d89ee89","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">aacc378d-3db3-4ada-ad84-ace29d89ee89</Id>
<AccountState>7</AccountState>
<ClubId>8d8c05a1-a10e-408a-927e-53edbf4cf6e1</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-11-03T12:50:24.8641934+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>6ddf03a6-80b1-42bb-96a2-2cd20c216f20</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>aacc378d-3db3-4ada-ad84-ace29d89ee89</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>4357f2b6-fa2b-4006-a08b-ebf0c3c3d933</d2p1:guid>
<d2p1:guid>909329ef-69cc-439d-9a62-72778a63f629</d2p1:guid>
</UserRoleIds>
</UserDetails>