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": "ea255eed-c9ba-4ee6-bc77-6cd072eb8569",
"ClubId": "34828f19-ffde-4c07-b48a-8b83e9d07a57",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "e4bff95a-5792-4bc3-bfdf-d1b892ca73a1",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"0eae8e57-a56c-44b9-9099-901953bc4162",
"18432214-e371-479d-b2a2-cd56cc59aaf7"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-01-05T04:29:59.0375442+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "ea255eed-c9ba-4ee6-bc77-6cd072eb8569",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"ea255eed-c9ba-4ee6-bc77-6cd072eb8569","ClubId":"34828f19-ffde-4c07-b48a-8b83e9d07a57","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"e4bff95a-5792-4bc3-bfdf-d1b892ca73a1","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["0eae8e57-a56c-44b9-9099-901953bc4162","18432214-e371-479d-b2a2-cd56cc59aaf7"],"AccountState":7,"LastPasswordChangeOn":"2026-01-05T04:29:59.0375442+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"ea255eed-c9ba-4ee6-bc77-6cd072eb8569","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">ea255eed-c9ba-4ee6-bc77-6cd072eb8569</Id>
<AccountState>7</AccountState>
<ClubId>34828f19-ffde-4c07-b48a-8b83e9d07a57</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-01-05T04:29:59.0375442+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>e4bff95a-5792-4bc3-bfdf-d1b892ca73a1</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>ea255eed-c9ba-4ee6-bc77-6cd072eb8569</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>0eae8e57-a56c-44b9-9099-901953bc4162</d2p1:guid>
<d2p1:guid>18432214-e371-479d-b2a2-cd56cc59aaf7</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": "5cac60f9-25e3-4139-a111-f69a0f9d384a",
"ClubId": "2a440251-25ba-48a6-b56e-e8c0d4b32a05",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "4e542a9a-22a4-4df3-9137-ebe537914570",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"91cc95d2-78c9-44c7-87f0-87f1d8f018fa",
"eae2eefd-35fc-4a6d-8e3d-4dcb2fb12482"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-01-05T04:29:59.0375442+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "5cac60f9-25e3-4139-a111-f69a0f9d384a",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"5cac60f9-25e3-4139-a111-f69a0f9d384a","ClubId":"2a440251-25ba-48a6-b56e-e8c0d4b32a05","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"4e542a9a-22a4-4df3-9137-ebe537914570","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["91cc95d2-78c9-44c7-87f0-87f1d8f018fa","eae2eefd-35fc-4a6d-8e3d-4dcb2fb12482"],"AccountState":7,"LastPasswordChangeOn":"2026-01-05T04:29:59.0375442+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"5cac60f9-25e3-4139-a111-f69a0f9d384a","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">5cac60f9-25e3-4139-a111-f69a0f9d384a</Id>
<AccountState>7</AccountState>
<ClubId>2a440251-25ba-48a6-b56e-e8c0d4b32a05</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-01-05T04:29:59.0375442+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>4e542a9a-22a4-4df3-9137-ebe537914570</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>5cac60f9-25e3-4139-a111-f69a0f9d384a</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>91cc95d2-78c9-44c7-87f0-87f1d8f018fa</d2p1:guid>
<d2p1:guid>eae2eefd-35fc-4a6d-8e3d-4dcb2fb12482</d2p1:guid>
</UserRoleIds>
</UserDetails>