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": "ebb5e8b6-6c44-401a-8102-0ea531518e5d",
"ClubId": "4cb4c67c-4951-41c5-b362-c78601b9e1cd",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "e85fd3a2-2b09-42b2-ad8e-5a7cdb3a6805",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"87d29a73-81a3-4eb6-90b7-c28d568b7ad0",
"a696cc9c-3743-4197-9c78-63e25a92ad88"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-05-30T03:53:33.5122327+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "ebb5e8b6-6c44-401a-8102-0ea531518e5d",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"ebb5e8b6-6c44-401a-8102-0ea531518e5d","ClubId":"4cb4c67c-4951-41c5-b362-c78601b9e1cd","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"e85fd3a2-2b09-42b2-ad8e-5a7cdb3a6805","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["87d29a73-81a3-4eb6-90b7-c28d568b7ad0","a696cc9c-3743-4197-9c78-63e25a92ad88"],"AccountState":7,"LastPasswordChangeOn":"2025-05-30T03:53:33.5122327+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"ebb5e8b6-6c44-401a-8102-0ea531518e5d","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">ebb5e8b6-6c44-401a-8102-0ea531518e5d</Id>
<AccountState>7</AccountState>
<ClubId>4cb4c67c-4951-41c5-b362-c78601b9e1cd</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-05-30T03:53:33.5122327+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>e85fd3a2-2b09-42b2-ad8e-5a7cdb3a6805</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>ebb5e8b6-6c44-401a-8102-0ea531518e5d</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>87d29a73-81a3-4eb6-90b7-c28d568b7ad0</d2p1:guid>
<d2p1:guid>a696cc9c-3743-4197-9c78-63e25a92ad88</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": "b7b45458-6c51-46ba-9570-21ce9724d27f",
"ClubId": "8b185d74-dbb9-417c-82fa-aa30f39eca86",
"FriendlyName": "sample string 3",
"NotificationEmail": "sample string 4",
"PersonId": "5d2a3253-6178-40df-971d-7bca61d67952",
"Remarks": "sample string 5",
"UserName": "sample string 6",
"UserRoleIds": [
"23e97726-6b92-48c6-a6e1-754dbd2edd9f",
"bd7a75d8-7532-484a-9871-fe80cf0186d2"
],
"AccountState": 7,
"LastPasswordChangeOn": "2025-05-30T03:53:33.5122327+02:00",
"ForcePasswordChangeNextLogon": true,
"EmailConfirmed": true,
"LanguageId": 10,
"Id": "b7b45458-6c51-46ba-9570-21ce9724d27f",
"CanUpdateRecord": true,
"CanDeleteRecord": true
}
text/html
Sample:
{"UserId":"b7b45458-6c51-46ba-9570-21ce9724d27f","ClubId":"8b185d74-dbb9-417c-82fa-aa30f39eca86","FriendlyName":"sample string 3","NotificationEmail":"sample string 4","PersonId":"5d2a3253-6178-40df-971d-7bca61d67952","Remarks":"sample string 5","UserName":"sample string 6","UserRoleIds":["23e97726-6b92-48c6-a6e1-754dbd2edd9f","bd7a75d8-7532-484a-9871-fe80cf0186d2"],"AccountState":7,"LastPasswordChangeOn":"2025-05-30T03:53:33.5122327+02:00","ForcePasswordChangeNextLogon":true,"EmailConfirmed":true,"LanguageId":10,"Id":"b7b45458-6c51-46ba-9570-21ce9724d27f","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">b7b45458-6c51-46ba-9570-21ce9724d27f</Id>
<AccountState>7</AccountState>
<ClubId>8b185d74-dbb9-417c-82fa-aa30f39eca86</ClubId>
<EmailConfirmed>true</EmailConfirmed>
<ForcePasswordChangeNextLogon>true</ForcePasswordChangeNextLogon>
<FriendlyName>sample string 3</FriendlyName>
<LanguageId>10</LanguageId>
<LastPasswordChangeOn>2025-05-30T03:53:33.5122327+02:00</LastPasswordChangeOn>
<NotificationEmail>sample string 4</NotificationEmail>
<PersonId>5d2a3253-6178-40df-971d-7bca61d67952</PersonId>
<Remarks>sample string 5</Remarks>
<UserId>b7b45458-6c51-46ba-9570-21ce9724d27f</UserId>
<UserName>sample string 6</UserName>
<UserRoleIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>23e97726-6b92-48c6-a6e1-754dbd2edd9f</d2p1:guid>
<d2p1:guid>bd7a75d8-7532-484a-9871-fe80cf0186d2</d2p1:guid>
</UserRoleIds>
</UserDetails>