post
https://api.zenoti.com/v1/employees
This API helps you to create an employee profile, along with catalog information in a center.
Note: For information on how to update the details of a previously-created employee profile, click here.
You must specify necessary details for the mandatory and optional object parameters in the API request body. If you assign a particular role to the specified employee, this API creates an employee profile with the provided role ID. Otherwise, this API assigns a default role to the newly-created employee.
For more information on security roles, refer to the Retrieve the list of security roles in a center API.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Request Body Parameters
EmployeeObjectModel
| Json property | Data type | Description |
|---|---|---|
| id | Guid | Unique identifier of the employee. |
| code | string | Code used to represent the employee. |
| center_id | Guid | Unique identifier of the center. |
| is_consultant | bool? | Indicates whether employee is a consultant. |
| created_by | Guid | Created by Id - login employee id. |
| personal_info | EmployeePersonalInfo | Personal information of the employee. |
| address | EmployeeAddress | Address information of the employee. |
| login_info | EmployeeLoginInfo | Login information of the employee. |
| job_info | EmployeeJobInfo | Job information of the employee. |
| preference_info | EmployeePreferenceInfo | Preference information of the employee. |
| payroll_info | EmployeePayrollInfo | Payroll information of the employee. |
| vanity_image_url | string | Employee profile image. |
| roles | EmployeeRoles | Employee roles. |
| catalog_info | EmployeeCatalogInfo | Catalog information of the employee. |
EmployeeRoles
| Json property | Data type | Description |
|---|---|---|
| security_profile_id | Guid | Unique identifier of the role. |
EmployeeJobInfo
| Json property | Data type | Description |
|---|---|---|
| job_id | Guid | Unique identifier of the job. |
| job_name | string | Name of the job. |
| designation_id | Guid? | Unique identifier of the designation. |
| company_name | string | Name of the company. |
| salary | double | Salary of the employee. |
| hourly_rate | double | Hourly rate of the employee. |
| holiday_pay_rate | double? | Holiday hours pay rate. |
| vacation_pay_rate | double? | Vacation hours pay rate. |
| overtime_baseline_hours | double | Overtime baseline hours. |
| overtime_type | int | Type of the overtime day, week or pay period. |
| overtime_multiplier | double? | Multiplier for the over time. |
| advanced_overtime | AdvancedOvertimeConfiguration | Advanced overtime configuration. |
| work_task_ids | List | Array of work task ids. |
| request_therapist_bonus | double | Therapist bonus requested for the employee. |
| mandatory_break_period | int | Break period given to the employee. |
| is_elgible_for_additional_commision_bonus | bool | Indicates whether employee is eligible for additional commission hours. |
| max_work_hours | int | Maximum working hours of the employee. |
| target_revenue | double | Target revenue of the employee. |
| vacation_days | int | Number of days given to employee for vacation. |
| special_leave_days | int | Number of days given to employee as special leave. |
| start_date | DateTime | Start date of the employee. |
| end_date | DateTime? | End date of the employee. |
| tenure_start_date | DateTime? | Tenure start date of the employee. |
| pay_type | EmployeePayType | Payroll type of the employee. |
EmployeePreferenceInfo
| Json property | Data type | Description |
|---|---|---|
| culture_id | int | Unique identifier of the culture. |
| search_tags | string | Tags associated to the employee. |
| receive_marketing_emails | bool | Indicates whether employee can receive marketing emails. |
| receive_marketing_messages | bool | Indicates whether employee can receive marketing messages. |
| receive_transactional_emails | bool | Indicates whether employee can receive transactional emails. |
| receive_transactional_messages | bool | Indicates whether employee can receive transactional messages. |
| receive_daily_reports | bool | Indicates whether employee can receive daily reports. |
| receive_register_closure_report | bool | Indicates whether employee can receive register closure report. |
| waive_biometric_checkin | bool | Indicates whether employee biometric check-in is waived or not. |
| access_manager_productivity_app | bool | Indicates whether employee can access manager productivity app. |
| is_mentor | bool | Indicates whether employee is a mentor. |
| access_employee_productivity_app | bool | Indicates whether employee can access employee productivity app. |
| access_code | string | Access code of the employee. |
| keyword | string | Keywords used to search the employee. |
| allow_analytics_access | int | Indicates analytics access level. |
| allow_api_access | bool | Indicates whether employee is granted to access the APIs. |
| text_field_1 | string | Primary text field. |
| text_field_2 | string | Secondary text field. |
| additional_date_1 | DateTime | Additional date given to the employee. |
| additional_date_2 | DateTime | Additional date given to the employee. |
| send_confirmation_for_scheduled_appointments | bool | Indicates whether to send confirmation email/text for scheduled appointments. |
EmployeePersonalInfo
| Json property | Data type | Description |
|---|---|---|
| first_name | string | First name of the employee. |
| middle_name | string | Middle name of the employee. |