Skip to main content
PATCH
Public Dismiss Employee
Marks an employee as dismissed (terminated), recording the dismissal date.
  • dismissal_date is required. The dismissal will be recorded on this date.
  • send_email (optional): when true, the dismissal notice will be sent on the date provided in send_date. If send_date is not provided, the current date will be used to send the notice.
  • The dismissal process inactivates the employee in the database and creates a dismissal medical exam for them.
  • Field: dismissal_date
  • Accepted format: ISO 8601
  • Valid examples:
    • YYYY-MM-DD — e.g., 2025-01-31 (date only)
    • YYYY-MM-DD HH:MM:SS — e.g., 2025-01-31 00:00:00 (with time in UTC)
  • If you use send_date, adopt the same format.

Overview

  • Method: PATCH
  • Path: /v0/employee/{employee_id}/dismiss
  • OperationId: public_dismiss_employee_v0_employee__employee_id__dismiss_patch
  • Authentication: header x-api-key

Example request

Example: email notification enabled

Authorizations

x-api-key
string
header
required

Path Parameters

employee_id
string<uuid>
required

Body

application/json
dismissal_date
string<date>
required
send_email
boolean
required
send_date
string<date-time> | null

Response

Successful Response

sucess
boolean
required