Skip to main content
PUT
/
employees
/
{id}
curl -X PUT https://api.companyflow.com/employees/emp-uuid-here \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1234567899",
    "status": "on_leave",
    "address": "456 New Street, City, State"
  }'

{
  "success": true,
  "data": {
    "id": "emp-uuid-here",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "john.doe@example.com",
    "phone": "+1234567899",
    "first_name": "John",
    "last_name": "Doe",
    "employee_code": "EMP001",
    "department_id": "new-dept-uuid",
    "designation_id": "new-desig-uuid",
    "level_id": "level-uuid-here",
    "role_id": "role-uuid-here",
    "manager_id": "manager-uuid-here",
    "status": "on_leave",
    "employment_type": "full_time",
    "date_of_birth": "1990-01-15T00:00:00Z",
    "hire_date": "2024-01-01T00:00:00Z",
    "termination_date": null,
    "gender": "Male",
    "address": "456 New Street, City, State",
    "emergency_contact_name": "Jane Doe",
    "emergency_contact_phone": "+1987654321",
    "profile_image_url": "",
    "last_login_at": "2024-03-01T15:30:00Z",
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2024-03-03T10:15:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Falasefemi2/companyflow/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

This endpoint requires Bearer token authentication with one of the following roles:
  • super_admin
  • hr_manager

​
Path Parameters

​
id
string
required
The unique identifier of the employee (UUID format)

​
Request Body

All fields are optional. Only include fields you want to update.
​
phone
string
Employee phone number
​
first_name
string
Employee first name
​
last_name
string
Employee last name
​
date_of_birth
string
Employee date of birth (format: YYYY-MM-DD)
​
department_id
string
Department UUID
​
designation_id
string
Designation UUID
​
level_id
string
Level UUID
​
manager_id
string
Manager UUID
​
status
string
Employee status. Must be one of:
  • active
  • inactive
  • on_leave
  • terminated
  • probation
​
gender
string
Employee gender
​
address
string
Employee address
​
emergency_contact_name
string
Emergency contact name
​
emergency_contact_phone
string
Emergency contact phone number
​
profile_image_url
string
Profile image URL
​
termination_date
string
Termination date (format: YYYY-MM-DD)

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
​
id
string
Employee UUID
​
company_id
string
Company UUID
​
email
string
Employee email address
​
phone
string
Employee phone number
​
first_name
string
Employee first name
​
last_name
string
Employee last name
​
employee_code
string
Internal employee code
​
department_id
string
Department UUID
​
designation_id
string
Designation UUID
​
level_id
string
Level UUID
​
role_id
string
Role UUID
​
manager_id
string
Manager UUID
​
status
string
Employee status
​
employment_type
string
Employment type
​
date_of_birth
string
Date of birth (ISO 8601 format)
​
hire_date
string
Hire date (ISO 8601 format)
​
termination_date
string
Termination date (ISO 8601 format)
​
gender
string
Employee gender
​
address
string
Employee address
​
emergency_contact_name
string
Emergency contact name
​
emergency_contact_phone
string
Emergency contact phone
​
profile_image_url
string
Profile image URL
​
last_login_at
string
Last login timestamp (ISO 8601 format)
​
created_at
string
Creation timestamp (ISO 8601 format)
​
updated_at
string
Last update timestamp (ISO 8601 format)
curl -X PUT https://api.companyflow.com/employees/emp-uuid-here \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+1234567899",
    "status": "on_leave",
    "address": "456 New Street, City, State"
  }'

{
  "success": true,
  "data": {
    "id": "emp-uuid-here",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "john.doe@example.com",
    "phone": "+1234567899",
    "first_name": "John",
    "last_name": "Doe",
    "employee_code": "EMP001",
    "department_id": "new-dept-uuid",
    "designation_id": "new-desig-uuid",
    "level_id": "level-uuid-here",
    "role_id": "role-uuid-here",
    "manager_id": "manager-uuid-here",
    "status": "on_leave",
    "employment_type": "full_time",
    "date_of_birth": "1990-01-15T00:00:00Z",
    "hire_date": "2024-01-01T00:00:00Z",
    "termination_date": null,
    "gender": "Male",
    "address": "456 New Street, City, State",
    "emergency_contact_name": "Jane Doe",
    "emergency_contact_phone": "+1987654321",
    "profile_image_url": "",
    "last_login_at": "2024-03-01T15:30:00Z",
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2024-03-03T10:15:00Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us