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": "ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5",
"ClubId": "d716d547-d82a-4ed6-8a2f-7d0b2e584311",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "0a879acd-db6e-4841-afa5-31100f80b053",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"6c8322eb-9e05-44f2-80fb-a5c49eff0989",
"59cbb7a7-0a35-4491-89ae-2746e205b139"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-04-04T02:51:56.2321209+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5","ClubId":"d716d547-d82a-4ed6-8a2f-7d0b2e584311","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"0a879acd-db6e-4841-afa5-31100f80b053","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["6c8322eb-9e05-44f2-80fb-a5c49eff0989","59cbb7a7-0a35-4491-89ae-2746e205b139"],"AccountState":7,"LastPasswordChangeOn":"2025-04-04T02:51:56.2321209+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5","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">ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5</Id>
<AccountState>7</AccountState>
<ClubId>d716d547-d82a-4ed6-8a2f-7d0b2e584311</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-04-04T02:51:56.2321209+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>0a879acd-db6e-4841-afa5-31100f80b053</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>ac7d0df4-d81a-4c5f-82ef-b8523db3a0f5</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6c8322eb-9e05-44f2-80fb-a5c49eff0989</d2p1:guid>
<d2p1:guid>59cbb7a7-0a35-4491-89ae-2746e205b139</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": "534d317e-bcee-47c1-af01-cfd7ab2fb202",
"ClubId": "e9e73f74-f6a9-4309-82ac-080f18be8ba6",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "4532936d-cb52-4483-bec9-79422bcfc822",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"f055afc7-d72d-4587-84e5-8c1ed4689860",
"b256a603-4e18-44bb-b008-6899a9566fdf"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-04-04T02:51:56.2321209+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "534d317e-bcee-47c1-af01-cfd7ab2fb202",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"534d317e-bcee-47c1-af01-cfd7ab2fb202","ClubId":"e9e73f74-f6a9-4309-82ac-080f18be8ba6","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4532936d-cb52-4483-bec9-79422bcfc822","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["f055afc7-d72d-4587-84e5-8c1ed4689860","b256a603-4e18-44bb-b008-6899a9566fdf"],"AccountState":7,"LastPasswordChangeOn":"2025-04-04T02:51:56.2321209+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"534d317e-bcee-47c1-af01-cfd7ab2fb202","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">534d317e-bcee-47c1-af01-cfd7ab2fb202</Id>
<AccountState>7</AccountState>
<ClubId>e9e73f74-f6a9-4309-82ac-080f18be8ba6</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-04-04T02:51:56.2321209+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>4532936d-cb52-4483-bec9-79422bcfc822</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>534d317e-bcee-47c1-af01-cfd7ab2fb202</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f055afc7-d72d-4587-84e5-8c1ed4689860</d2p1:guid>
<d2p1:guid>b256a603-4e18-44bb-b008-6899a9566fdf</d2p1:guid>
</UserRoleIds>
</UserDetails>