The Accounts API empowers you to manage one account.
| Parameter name | Value | Description | Notes |
|---|---|---|---|
id |
string | Identifier of the account | |
userName |
string |
user name of the user account. The same value as the email address. Read-only | writable only for insert. Max length: 63. |
firstName |
string |
First name of the user account. Max length: 63. | writable |
lastName |
string |
Last name of the user account. Max length: 63. | writable |
email |
string |
Email address of the user account. Used as user name, it is not possible to change after account creation. | writable only for insert. Max length: 63. |
ssoToken |
string |
The SSO token to use to connect to API with the user account. Read-only | |
profileSettings |
object |
Profile settings of the user account. | writable |
profileSettings.preferences |
object |
Preferences of the user account. | writable |
profileSettings.preferences.timeZone |
string |
Time zone code of the user account. Possible values can be found here. | writable |
profileSettings.preferences.language |
string |
Spoken language of the user account. | writable |
profileSettings.preferences.pdfExportSize |
string |
Size format of the PDF export pages. | writable |
picture |
object |
User account picture url and mime type. | writable |
picture.url |
string |
Url of the user account picture. | |
picture.mimeType |
string |
Mime type of the user account picture file. | |
scheduling |
object |
Scheduling user account settings. | writable |
defaultCalendarView.url |
string |
Default calendar view. | "dail", "weekly", "monthly". writable. |
Return an account details.
Authentication is required to execute this request. Please refer to Authentication for more.
Do not supply a request body with this method.
If successful, this method returns a Account resource in the response body.
Update an account details.
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Account resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
lastName |
string |
Last name of the client. |
picture |
object |
Account picture . |
picture.data |
string |
Data URI of the account picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored. |
If successful, this method returns a Account resource in the response body.