Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Add employee with catalog information

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.

post/v1/employees

Request body

raw_bodystring json

Response

200

OR
OR
OR

Example response

{
  "id": "447fc2fd-3c54-47ec-932a-cce1523a6fc7",
  "code": "ApiDirectUser2",
  "center_id": "a11f578a-1b81-4de0-8834-915f79e5362b",
  "personal_info": {
    "first_name": "ApiDirect2",
    "last_name": "User",
    "nick_name": "Api test2",
    "notification_name": "Api Direct Test2",
    "email": "vishnu2@gmail.com",
    "mobile_phone": {
      "country_code": 91,
      "phone_code": 504,
      "number": "1234567890"
    },
    "home_phone": {
      "country_code": 95,
      "phone_code": 91
    },
    "work_phone": {
      "country_code": 95,
      "phone_code": 91
    },
    "gender": 1,
    "birth_date": "0001-01-01T00:00:00",
    "anniversary_date": "0001-01-01T00:00:00"
  },
  "address": {
    "country_id": 95,
    "state_id": -2
  },
  "login_info": {
    "username": "vishnu2@gmail.com"
  },
  "job_info": {
    "job_id": "b580ce93-b472-480d-af6f-6235f4a84eba",
    "job_name": "AM job",
    "salary": 50,
    "hourly_rate": 25,
    "vacation_pay_rate": 10,
    "holiday_pay_rate": 10,
    "overtime_multiplier": 1,
    "start_date": "2014-12-08T00:00:00",
    "end_date": "0001-01-01T00:00:00",
    "tenure_start_date": "0001-01-01T00:00:00"
  },
  "preference_info": {
    "culture_id": 202,
    "search_tags": "Employee Tag 1",
    "receive_marketing_emails": true,
    "receive_marketing_messages": true,
    "receive_transactional_emails": true,
    "receive_transactional_messages": true,
    "additional_date_1": "0001-01-01T00:00:00",
    "additional_date_2": "0001-01-01T00:00:00",
    "send_confirmation_for_scheduled_appointments": true
  },
  "roles": {
    "security_profile_id": "649803c6-4153-4957-8b66-e0742447ce2a"
  },
  "catalog_info": {
    "show_in_catalog": true,
    "display_name": "catalog display name",
    "description": "this is a description"
  }
}