/employees/ignore/{model_id}

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The “reason” and “message” fields in the request body will be stored for audit purposes.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

model_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

reasonenumRequired

GENERAL_CUSTOMER_REQUEST - GENERAL_CUSTOMER_REQUEST
GDPR - GDPR
OTHER - OTHER

* `GENERAL_CUSTOMER_REQUEST` - GENERAL_CUSTOMER_REQUEST * `GDPR` - GDPR * `OTHER` - OTHER

Allowed values:

messagestringOptional1-256 characters

Response

No response body

Supported POST model parameters

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

work_locationstring or nullRequiredformat: "uuid"

The employee's work address.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you’re looking for the employee’s start date, refer to the start_date field.

Supported POST model parameters

employee_numberstring or nullRequired

The employee’s number that appears in the third-party integration’s UI.

last_namestring or nullRequired

The employee's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

personal_emailstring or nullRequiredformat: "email"<=254 characters

The employee's personal email.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

remote_idstring or nullOptional

The third-party API ID of the matching object.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

Supported POST model parameters

companystring or nullRequiredformat: "uuid"

The ID of the employee's company.

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

employmentslist of stringsRequired

Array of Employment IDs for this Employee.

home_locationstring or nullRequiredformat: "uuid"

The employee's home address.

managerstring or nullRequiredformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullRequiredformat: "uuid"

The employee's pay group

ssnstring or nullRequired<=100 characters

The employee's social security number.

genderenum or nullRequired

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullRequired

The employee's date of birth.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

Supported POST model parameters

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

first_namestring or nullOptional

The employee's first name.

last_namestring or nullOptional

The employee's last name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

avatarstring or nullOptionalformat: "uri"<=2000 characters

The URL of the employee's avatar image.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

work_locationstring or nullRequiredformat: "uuid"

The employee's work address.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

date_of_birthdatetime or nullOptional

The employee's date of birth.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

hire_datedatetime or nullOptionalDeprecated

Supported POST model parameters

employee_numberstring or nullRequired

The employee’s number that appears in the third-party integration’s UI.

last_namestring or nullRequired

The employee's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional

The employee's first name.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

personal_emailstring or nullOptionalformat: "email"<=254 characters

The employee's personal email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

personal_emailstring or nullRequiredformat: "email"<=254 characters

The employee's personal email.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

companystring or nullOptionalformat: "uuid"

The ID of the employee's company.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

mobile_phone_numberstring or nullOptional

The employee's mobile phone number.

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

home_locationstring or nullOptionalformat: "uuid"

The employee's home address.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

managerstring or nullOptionalformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullOptionalformat: "uuid"

The employee's pay group

ssnstring or nullOptional<=100 characters

The employee's social security number.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

ethnicityenum or nullOptional

The employee’s ethnicity.

AMERICAN_INDIAN_OR_ALASKA_NATIVE - AMERICAN_INDIAN_OR_ALASKA_NATIVE
ASIAN_OR_INDIAN_SUBCONTINENT - ASIAN_OR_INDIAN_SUBCONTINENT
BLACK_OR_AFRICAN_AMERICAN - BLACK_OR_AFRICAN_AMERICAN
HISPANIC_OR_LATINO - HISPANIC_OR_LATINO
NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER - NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER
TWO_OR_MORE_RACES - TWO_OR_MORE_RACES
WHITE - WHITE
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

marital_statusenum or nullOptional

The employee’s filing status as related to marital status.

SINGLE - SINGLE
MARRIED_FILING_JOINTLY - MARRIED_FILING_JOINTLY
MARRIED_FILING_SEPARATELY - MARRIED_FILING_SEPARATELY
HEAD_OF_HOUSEHOLD - HEAD_OF_HOUSEHOLD
QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD - QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD

Allowed values:

date_of_birthdatetime or nullOptional

The employee's date of birth.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

termination_datedatetime or nullOptional

The employee's termination date.

teamstring or nullOptionalformat: "uuid"Deprecated

The employee's team.

Supported POST model parameters

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

work_emailstring or nullRequiredformat: "email"<=254 characters

The employee's work email.

remote_idstring or nullOptional

The third-party API ID of the matching object.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

groupslist of stringsOptional

employmentslist of stringsOptional

Array of Employment IDs for this Employee.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

genderenum or nullOptional

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

start_datedatetime or nullOptional

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

Supported POST model parameters

companystring or nullRequiredformat: "uuid"

The ID of the employee's company.

first_namestring or nullRequired

The employee's first name.

last_namestring or nullRequired

The employee's last name.

employmentslist of stringsRequired

Array of Employment IDs for this Employee.

home_locationstring or nullRequiredformat: "uuid"

The employee's home address.

managerstring or nullRequiredformat: "uuid"

The employee ID of the employee's manager.

pay_groupstring or nullRequiredformat: "uuid"

The employee's pay group

ssnstring or nullRequired<=100 characters

The employee's social security number.

genderenum or nullRequired

The employee’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

date_of_birthdatetime or nullRequired

The employee's date of birth.

start_datedatetime or nullRequired

The date that the employee started working. If an employee was rehired, the most recent start date will be returned.

remote_idstring or nullOptional

The third-party API ID of the matching object.

employee_numberstring or nullOptional

The employee’s number that appears in the third-party integration’s UI.

display_full_namestring or nullOptional

The employee's full name, to use for display purposes. If a preferred first name is available, the full name will include the preferred first name.

usernamestring or nullOptional

The employee's username that appears in the remote UI.

work_emailstring or nullOptionalformat: "email"<=254 characters

The employee's work email.

work_locationstring or nullOptionalformat: "uuid"

The employee's work address.

remote_created_atdatetime or nullOptional

When the third party's employee was created.

employment_statusenum or nullOptional

The employment status of the employee.

ACTIVE - ACTIVE
PENDING - PENDING
INACTIVE - INACTIVE

Allowed values:

1	curl -X POST https://api.merge.dev/api/hris/v1/employees/ignore/model_id \
2	-H "X-Account-Token: X-Account-Token" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"reason": "GENERAL_CUSTOMER_REQUEST"
7	}'

/employees/ignore/{model_id}

Authentication

Path parameters

Headers

Request

Response

Field support by integration

Field support by integration