This API updates the existing employee profile with additional parameters for taking catalog information. If the catalog details are provided then the same will be updated and other values are set to default. If the sub-object catalog details are not passed in the request body, the default values will be set for catalog details ('ShowInCatalog' are set to false and ‘DisplayName' and 'Description’ would be set to empty)..
Note: For information on how to create an employee profile in a center, click here.
You must specify necessary details for the employee_id URI parameter in the API request. If you assign a new role ID to the employee, this API will update the employee's profile with the specified role ID and remove the existing role IDs. For more information on security roles, refer to the Retrieve the list of security roles in a center API.
Optionally, you can specify updated information for any of the request body parameters.
Request Body Parameters
Employee Object Details
| Property | Type | Description |
|---|---|---|
| id | guid | Unique identifier of the employee. |
| code | string | Code that is used to represent the employee. |
| center_id | guid | Unique 32-character identifier of the center. |
| is_consultant | bool | Boolean which represents whether the employee is a consultant or not. |
| created_by | guid | Created by ID - Login Employee ID. |
| vanity_image_url | string | Employee profile image. |
| personal_info | object | Object that contains the employee's personal information-related elements. For more information, refer to the Personal Information section. |
| address | object | Object that contains the employee's address information-related elements. For more information, refer to the Address Information section. |
| login_info | object | Object that contains the employee's login information-related element: username (email ID). |
| job_info | object | Object that contains the employee's job information-related elements. For more information, refer to the Job Information section. |
| preference_info | object | Object that contains the employee's preference information-related elements. For more information, refer to the Preference Information section. |
| catalog_info | object | Object that contains the catalog information of the employee. For more information, refer to the Catalog Information section. |
| roles | object | Object that contains the employee's security profile ID element: security_profile_id. For more information, refer to the Roles Information section. |
| error | object | Object that contains error message and error code details. For more information, refer to the Error Information section. |
Personal Information
| Property | Type | Description |
|---|---|---|
| first_name | string | First name of the employee. |
| middle_name | string | Middle name of the employee. |
| last_name | string | Last name of the employee. |
| nick_name | string | Nickname of the employee. |
| notification_name | string | Name of the employee that is to be displayed in notifications. |
| string | Email ID of the employee. | |
| mobile_phone | object | Object that contains the employee's mobile phone-related elements: country_code and number. |
| home_phone | object | Object that contains the employee's home phone-related elements: country_code and number. |
| work_phone | object | Object that contains the employee's work phone-related elements: country_code and number. |
| gender | enum | Indicates the gender of the employee: NotSpecified - -1, Male - 1, Female - 0, and Other - 3. |
| birth_date | datetime | Birth date and time of the employee. |
| anniversary_date | datetime | Date and time of the employee's anniversary. |
Address Information
| Property | Type | Description |
|---|---|---|
| address_1 | string | Primary address of the employee. |
| address_2 | string | Secondary address of the employee. |
| city | string | City in which the employee resides. |
| country_id | int | Unique ID of the country to which employee belongs. You can retrieve the appropriate country_id by using the List all countries API. |
| state_id | int | Unique ID of the state to which employee belongs. |
| zip_code | string | Zip code of the employee's address. |
Job Information
| Property | Type | Description |
|---|---|---|
| job_id | guid | Unique 32-character identifier of the employee's job. |
| job_name | string | Name of the employee's job. |
| designation_id | guid | Unique 32-character identifier of the employee's designation. |
| company_name | string | Name of the employee's company. |
| salary | decimal | Salary of the employee. |
| hourly_rate | decimal | Hourly rate of the employee. |
| overtime_baseline_hours | decimal | If the employee works for more than the specified number of overtime_baseline_hours, it is considered as overtime for that employee. |
| overtime_type | int | Type of the employee's overtime: weekly = 7. |
| overtime_multiplier | decimal | Multiplier for the employee's overtime amount. Employee's overtime payment amount = (overtime_multiplier x base rate amount of the employee). |
| work_task_ids | Collection of guid | Array of work task IDs for the employee. |
| request_therapist_bonus | decimal | Therapist bonus requested for the employee. |
| mandatory_break_period | int | Mandatory break period time provided to the employee. |
| is_eligible_for_additional_commision_bonus | boolean | Indicates whether the employee is eligible for additional commission hours. |
| max_work_hours | int | Maximum number of working hours of the employee. |
| target_revenue | decimal | Target revenue of the employee. |
| vacation_days | int | Number of days provided to the employee for vacation. |
| special_leave_days | int | Number of days provided to the employee as special leave days. |
| start_date | datetime | Date on which the employee started to work in the center. |
| end_date | datetime | Date on which the employee stopped to work in the center. |
| tenure_start_date | datetime | Tenure start date of the employee. |
| pay_type | enum | Indicates the type of payment type received by the employee: 0 - center default payment type, 1 - Hourly pay + commission (overtime exempt), 2 - Hourly pay + commission (overtime eligible). |
Preference Information
| Property | Type | Description |
|---|---|---|
| culture_id | int | Unique identifier of the employee's culture. |
| search_tags | string | Search tags associated with the employee. |
| receive_marketing_emails | boolean | Indicates whether the employee can receive marketing emails. |
| receive_marketing_messages | boolean | Indicates whether the employee can receive marketing messages. |
| receive_transactional_emails | boolean | Indicates whether the employee can receive transactional emails. |
| receive_transactional_messages | boolean | Indicates whether the employee can receive transactional messages. |
| receive_daily_reports | boolean | Indicates whether the employee can receive daily reports. |
| receive_register_closure_report | boolean | Indicates whether the employee can receive the Register Closure report. |
| waive_biometric_checkin | boolean | Indicates whether the employee's biometric check-in process has been waived. |
| access_manager_productivity_app | boolean | Indicates whether the employee can access the Manager Productivity app. |
| is_mentor | boolean | Indicates whether the employee is a mentor. |
| access_employee_productivity_app | boolean | Indicates whether the employee can access the Employee Productivity app. |
| access_code | string | Access code of the employee. |
| keyword | string | Keywords used to search for the employee. |
| allow_analytics_access | int | If true, it indicates that the employee has been granted access to analytics data. |
| allow_api_access | boolean | If true, it indicates that the employee has been granted access to APIs. |
| text_field_1 | string | Primary text field. |
| text_field_2 | string | Secondary text field. |
| additional_date_1 | datetime | Any additional date of significance provided to the employee. |
| additional_date_2 | datetime | Any further additional date of significance provided to the employee. |
| send_confirmation_for_scheduled_appointments | boolean | Send confirmation email and text to guests for appointments scheduled for this employee. |
Catalog Information
| Property | Type | Description |
|---|---|---|
| show_in_catalog | boolean | Show the employee details in the catalog. |
| display_name | string | Display the name of the employee. |
| description | string | Brief description of the employee. |
Roles Information
| Property | Type | Description |
|---|---|---|
| security_profile_id | guid | The security profile ID element of the employee's roles. |
Error Information
| Property | Type | Description |
|---|---|---|
| code | int | Error code detailing any issues encountered. |
| message | string | Error message providing additional context. |
