employees create
POST {{baseUrl}}/employees
Creates an Employee object with the given values.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
is_debug_mode | boolean | Whether to include debug fields (such as log file links) in the response. | |
run_async | boolean | Whether or not third-party updates should be run asynchronously. |
Request Body
[{"name"=>"remote_id", "value"=>"19202938", "datatype"=>"number"}, {"name"=>"employee_number", "value"=>"2", "datatype"=>"number"}, {"name"=>"company", "value"=>"8d9fd929-436c-4fd4-a48b-0c61f68d6178", "datatype"=>"string"}, {"name"=>"first_name", "value"=>"Greg", "datatype"=>"string"}, {"name"=>"last_name", "value"=>"Hirsch", "datatype"=>"string"}, {"name"=>"display_full_name", "value"=>"Cousin Greg Hirsch", "datatype"=>"string"}, {"name"=>"username", "value"=>"cousingreg", "datatype"=>"string"}, {"name"=>"groups", "value"=>"[\"21a54124-397f-494d-985e-3c5b330b8a68\"]", "datatype"=>"string"}, {"name"=>"work_email", "value"=>"greg@merge.dev", "datatype"=>"string"}, {"name"=>"personal_email", "value"=>"greg@gmail.com", "datatype"=>"string"}, {"name"=>"mobile_phone_number", "value"=>"+1234567890", "datatype"=>"string"}, {"name"=>"employments", "value"=>"[\"17a54124-287f-494d-965e-3c5b330c9a68\"]", "datatype"=>"string"}, {"name"=>"home_location", "value"=>"d2f972d0-2526-434b-9409-4c3b468e08f0", "datatype"=>"string"}, {"name"=>"work_location", "value"=>"9efbc633-3387-4306-aa55-e2c635e6bb4f", "datatype"=>"string"}, {"name"=>"manager", "value"=>"0048ea5b-911e-4dff-9364-92070dea62ff", "datatype"=>"string"}, {"name"=>"team", "value"=>"249c9faa-3045-4a31-953b-8f22d3613301", "datatype"=>"string"}, {"name"=>"pay_group", "value"=>"ad1264e2-39be-4787-b749-f1aade9e3405", "datatype"=>"string"}, {"name"=>"ssn", "value"=>"1234567890", "datatype"=>"number"}, {"name"=>"gender", "value"=>"OTHER", "datatype"=>"string"}, {"name"=>"ethnicity", "value"=>"AMERICAN_INDIAN_OR_ALASKA_NATIVE", "datatype"=>"string"}, {"name"=>"marital_status", "value"=>"MARRIED_FILING_SEPARATELY", "datatype"=>"string"}, {"name"=>"date_of_birth", "value"=>"1990-11-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"hire_date", "value"=>"2020-10-10T00:00:00Z", "datatype"=>"string"}, {"name"=>"start_date", "value"=>"2020-10-11T00:00:00Z", "datatype"=>"string"}, {"name"=>"remote_created_at", "value"=>"2020-10-11T00:00:00Z", "datatype"=>"string"}, {"name"=>"employment_status", "value"=>"PENDING", "datatype"=>"string"}, {"name"=>"termination_date", "value"=>"2021-10-12T00:00:00Z", "datatype"=>"string"}, {"name"=>"avatar", "value"=>"http://alturl.com/h2h8m", "datatype"=>"string"}, {"name"=>"custom_fields", "value"=>"{\"ea11\":{},\"officiac4e\":{},\"esse54\":{},\"veniam35\":{}}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Account-Token | string | (Required) Token identifying the end user. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"errors":[{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"m"}},{"detail":"custom_fields is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","title":"Missing Required Field","source":{"pointer":"dolor aliquip aliqua id"}}],"model":{"id":"0958cbc6-6040-430a-848e-aafacbadf4ae","remote_id":"19202938","employee_number":"2","company":"8d9fd929-436c-4fd4-a48b-0c61f68d6178","first_name":"Greg","last_name":"Hirsch","display_full_name":"Cousin Greg Hirsch","username":"cousingreg","groups":["21a54124-397f-494d-985e-3c5b330b8a68"],"work_email":"greg@merge.dev","personal_email":"greg@gmail.com","mobile_phone_number":"+1234567890","employments":["17a54124-287f-494d-965e-3c5b330c9a68"],"home_location":"d2f972d0-2526-434b-9409-4c3b468e08f0","work_location":"9efbc633-3387-4306-aa55-e2c635e6bb4f","manager":"0048ea5b-911e-4dff-9364-92070dea62ff","team":"249c9faa-3045-4a31-953b-8f22d3613301","pay_group":"ad1264e2-39be-4787-b749-f1aade9e3405","ssn":"1234567890","gender":"MALE","ethnicity":"ASIAN_OR_INDIAN_SUBCONTINENT","marital_status":"SINGLE","date_of_birth":"1990-11-10T00:00:00Z","hire_date":"2020-10-10T00:00:00Z","start_date":"2020-10-11T00:00:00Z","remote_created_at":"2020-10-11T00:00:00Z","employment_status":"INACTIVE","termination_date":"2021-10-12T00:00:00Z","avatar":"http://alturl.com/h2h8m","remote_data":[{"path":"laborum in ex in nisi","data":{"non_7b0":{},"elitd":{}}},{"path":"ad labore do aliqua dolor","data":{"Duis_7":{},"aute44":{},"in1a":{},"suntdf2":{}}}],"custom_fields":{"nulla_a0":{}},"remote_was_deleted":false},"warnings":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"voluptate elit fugiat"}},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","title":"Unrecognized Field","source":{"pointer":"Excepteur inci"}}],"logs":[{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}},{"dashboard_view":"https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_id":"99433219-8017-4acd-bb3c-ceb23d663832","log_summary":{"method":"POST","status_code":200,"url":"https://harvest.greenhouse.io/v1/candidates/"}}]}