Employee Management

Update an employee

patch/employees/{id}

Path parameters

idnumber required
Example:1

The ID of the entity

Request body

emailstring

Employee email address

firstNamestring

First name

lastNamestring

Last name

passwordstring

Password (min 6 chars)

role'employee' | 'admin'

User role (employee or admin)

zendeskAgentEmailstring nullable

Zendesk agent email used to assign tickets (optional)

isActiveboolean

Is employee active

Example request

{
  "email": "john.doe@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "password": "password123",
  "role": "employee",
  "zendeskAgentEmail": "john.doe@company.zendesk.com",
  "isActive": true
}

Response

Employee updated successfully.

Changes

No recorded changes to this endpoint across all 1 revision of this API.