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": "8025ff7c-2af7-4e80-b6fe-f6f453b4f288",
"ClubId": "1edf26a5-b580-4f9d-8cc5-14293dbf85b1",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "aae6f2fd-5482-4a39-b49b-20061787423e",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"46c4b498-bc9b-4c1d-bba7-795ed1a63486",
"e3c4ae11-55e6-4fad-89b6-3a4c7b58a347"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-20T06:08:32.2956312+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "8025ff7c-2af7-4e80-b6fe-f6f453b4f288",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"8025ff7c-2af7-4e80-b6fe-f6f453b4f288","ClubId":"1edf26a5-b580-4f9d-8cc5-14293dbf85b1","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"aae6f2fd-5482-4a39-b49b-20061787423e","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["46c4b498-bc9b-4c1d-bba7-795ed1a63486","e3c4ae11-55e6-4fad-89b6-3a4c7b58a347"],"AccountState":7,"LastPasswordChangeOn":"2026-02-20T06:08:32.2956312+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"8025ff7c-2af7-4e80-b6fe-f6f453b4f288","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">8025ff7c-2af7-4e80-b6fe-f6f453b4f288</Id>
<AccountState>7</AccountState>
<ClubId>1edf26a5-b580-4f9d-8cc5-14293dbf85b1</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-20T06:08:32.2956312+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>aae6f2fd-5482-4a39-b49b-20061787423e</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>8025ff7c-2af7-4e80-b6fe-f6f453b4f288</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>46c4b498-bc9b-4c1d-bba7-795ed1a63486</d2p1:guid>
<d2p1:guid>e3c4ae11-55e6-4fad-89b6-3a4c7b58a347</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": "c9356015-7c67-4db6-b52d-cee65fc0f740",
"ClubId": "e3237197-4b05-4c1a-9e86-b472456a5970",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "d8c726d5-81ed-4db2-b415-9ba146c43c41",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"6436e58b-2701-4bff-ab41-249c80cbb6d5",
"3ced0c5f-9286-4ff4-a05d-fbfea7181a14"
],
"AccountState": 7,
"LastPasswordChangeOn": "2026-02-20T06:08:32.2956312+01:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "c9356015-7c67-4db6-b52d-cee65fc0f740",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"c9356015-7c67-4db6-b52d-cee65fc0f740","ClubId":"e3237197-4b05-4c1a-9e86-b472456a5970","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"d8c726d5-81ed-4db2-b415-9ba146c43c41","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["6436e58b-2701-4bff-ab41-249c80cbb6d5","3ced0c5f-9286-4ff4-a05d-fbfea7181a14"],"AccountState":7,"LastPasswordChangeOn":"2026-02-20T06:08:32.2956312+01:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"c9356015-7c67-4db6-b52d-cee65fc0f740","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">c9356015-7c67-4db6-b52d-cee65fc0f740</Id>
<AccountState>7</AccountState>
<ClubId>e3237197-4b05-4c1a-9e86-b472456a5970</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2026-02-20T06:08:32.2956312+01:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>d8c726d5-81ed-4db2-b415-9ba146c43c41</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>c9356015-7c67-4db6-b52d-cee65fc0f740</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>6436e58b-2701-4bff-ab41-249c80cbb6d5</d2p1:guid>
<d2p1:guid>3ced0c5f-9286-4ff4-a05d-fbfea7181a14</d2p1:guid>
</UserRoleIds>
</UserDetails>