employees

Updates all information in one employee profile. This endpoint replaces all information on the record, so fields which are not specified will be cleared. First name, last name and email cannot be modified for employee profiles which correspond to users who can log in to the system.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The eCMS ID of the employee profile to update

integer

Range: inclusive between 1 and 9.22337203685478E+18

emailAddress

string

None.

employeeId

string

None.

firstName

string

Required

lastName

string

Required

phoneNumber

string

None.

hireDate

string

None.

terminationDate

Date of termination. Leave blank for current employees. If this employee has a user account, they will no longer be able to log in after this date.

string

None.

notes

string

None.

sites

All site memberships. Any current memberships that are not included here will be removed.

Collection of EmployeeSiteDto

None.

isSingleSignOnUser

boolean

None.

Body Parameters

None.

Response Information

Standard Responses

None.

Error Responses

None.
HTTP Status CodeError MessageTypeAdditional Information