Back
PUT api/v1/Account/Details
Requires Authorization
Update Firstname,LastName,PhoneNumber,TimeZone,Language of a registered user. Phone number will be updated only if the request contains a value for the phone number
Authorization Required
Request Information
URI Parameters
None.
Body Parameters
UpdateUserProfileBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName |
User's first name |
string |
Required Max length: 255 |
| LastName |
User's last name |
string |
Required Max length: 255 |
| PhoneNumber |
Phone number.This can be null.Only if the request contains a value for the phone number, it will be updated. |
string |
Max length: 100 |
| Language |
Language code. List of supported languages can be retrieved using the endpoint : api/v1/Lookup/Language |
string |
Required Max length: 10 |
| TimeZone |
Timezone code. List of timezones can be retrieved using the endpoint : api/v1/Lookup/TimeZone. |
string |
Max length: 100 |
| NotificationEmail |
A valid email address to be used as an alternate notification address. |
string |
Max length: 255 |
Sample Request
Request Formats
application/json, text/json
{
"FirstName": "John",
"LastName": "Smith",
"PhoneNumber": "3102100990",
"Language": "en-us",
"TimeZone": "US Eastern Standard Time",
"NotificationEmail": null
}
Response Information
Resource Description
UserProfileViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TimeZone |
Time zone |
string |
None. |
| Language |
Language |
string |
None. |
| FirstName |
User's first name |
string |
Max length: 255 |
| LastName |
User's last name |
string |
Max length: 255 |
| PhoneNumber |
Users's phone number |
string |
Max length: 100 |
| UserName |
Username i.e. email address user registered with |
string |
Max length: 256 |
| NotificationEmail |
Notification email address for user |
string |
Max length: 255 |
Sample Response
application/json, text/json
{
"TimeZone": "US Eastern Standard Time",
"Language": "en-us",
"FirstName": "John",
"LastName": "Smith",
"PhoneNumber": "3102100990",
"UserName": "user@company.com",
"NotificationEmail": null
}