Update Leave Type

curl -X PUT https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "daysAllowed": 22,
    "maxCarryForwardDays": 10,
    "description": "Updated policy with increased allowance"
  }'

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      daysAllowed: 22,
      maxCarryForwardDays: 10,
      description: 'Updated policy with increased allowance'
    })
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
}
payload = {
    'daysAllowed': 22,
    'maxCarryForwardDays': 10,
    'description': 'Updated policy with increased allowance'
}

response = requests.put(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Annual Leave",
    "code": "AL",
    "description": "Updated policy with increased allowance",
    "days_allowed": 22,
    "is_paid": true,
    "requires_documentation": false,
    "carry_forward_allowed": true,
    "max_carry_forward_days": 10,
    "color_code": "#3B82F6",
    "status": "active",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-03-03T15:45:00Z"
  }
}

{
  "success": false,
  "message": "invalid request body"
}

{
  "success": false,
  "message": "unauthorized"
}

PUT

leave-types

{id}

curl -X PUT https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "daysAllowed": 22,
    "maxCarryForwardDays": 10,
    "description": "Updated policy with increased allowance"
  }'

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      daysAllowed: 22,
      maxCarryForwardDays: 10,
      description: 'Updated policy with increased allowance'
    })
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
}
payload = {
    'daysAllowed': 22,
    'maxCarryForwardDays': 10,
    'description': 'Updated policy with increased allowance'
}

response = requests.put(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Annual Leave",
    "code": "AL",
    "description": "Updated policy with increased allowance",
    "days_allowed": 22,
    "is_paid": true,
    "requires_documentation": false,
    "carry_forward_allowed": true,
    "max_carry_forward_days": 10,
    "color_code": "#3B82F6",
    "status": "active",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-03-03T15:45:00Z"
  }
}

{
  "success": false,
  "message": "invalid request body"
}

{
  "success": false,
  "message": "unauthorized"
}

Update the configuration of an existing leave type. Both PUT and PATCH methods are supported. This endpoint allows you to modify leave policies, allowances, and other settings.

Authentication

Requires authentication with Bearer token. Available to:

Super Admin
HR Manager

Path Parameters

string

required

The unique identifier of the leave type (UUID format)Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Request Body

All fields are optional. Only include the fields you want to update.

string

Name of the leave typeExample: "Annual Leave (Updated)"

string

Short code for the leave typeExample: "AL"

string

Detailed description of the leave typeExample: "Updated policy for annual vacation time"

number

Total number of days allowed per yearExample: 22

boolean

Whether this leave type is paid or unpaidExample: true

boolean

Whether documentation is requiredExample: true

boolean

Whether unused days can be carried forwardExample: true

number

Maximum number of days that can be carried forwardExample: 10

string

Hex color code for calendar displayExample: "#10B981"

string

Status of the leave type: active or inactiveExample: "active"

Response

boolean

Indicates if the request was successful

object

The updated leave type object

Show LeaveType properties

string

Unique identifier for the leave type

string

UUID of the company

string

Name of the leave type

string

Short code for the leave type

string

Detailed description

number

Total days allowed per year

boolean

Whether the leave is paid

boolean

Whether documentation is required

boolean

Whether carry forward is allowed

number

Maximum carry forward days

string

Hex color code

string

Status: active or inactive

string

ISO 8601 timestamp

string

ISO 8601 timestamp (reflects latest update)

curl -X PUT https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "daysAllowed": 22,
    "maxCarryForwardDays": 10,
    "description": "Updated policy with increased allowance"
  }'

const response = await fetch(
  'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      daysAllowed: 22,
      maxCarryForwardDays: 10,
      description: 'Updated policy with increased allowance'
    })
  }
);

const data = await response.json();

import requests

url = 'https://api.companyflow.com/leave-types/a1b2c3d4-e5f6-7890-abcd-ef1234567890'
headers = {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
}
payload = {
    'daysAllowed': 22,
    'maxCarryForwardDays': 10,
    'description': 'Updated policy with increased allowance'
}

response = requests.put(url, json=payload, headers=headers)
data = response.json()

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Annual Leave",
    "code": "AL",
    "description": "Updated policy with increased allowance",
    "days_allowed": 22,
    "is_paid": true,
    "requires_documentation": false,
    "carry_forward_allowed": true,
    "max_carry_forward_days": 10,
    "color_code": "#3B82F6",
    "status": "active",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-03-03T15:45:00Z"
  }
}

{
  "success": false,
  "message": "invalid request body"
}

{
  "success": false,
  "message": "unauthorized"
}

Changes to leave type configuration will affect all future leave requests. Existing approved leave requests will not be modified.

PATCH vs PUT

This endpoint supports both HTTP methods:

PUT: Update specific fields (partial update)
PATCH: Update specific fields (partial update)

Both methods work identically - you only need to include the fields you want to update.

Authentication

Companies

Employees

Departments

Designations

Levels

Roles & Permissions

Leave Types

Leave Requests

Leave Balances

Memos

Approvals

Authentication

Path Parameters

Request Body

Response

PATCH vs PUT

​Authentication

​Path Parameters

​Request Body

​Response

​PATCH vs PUT

Authentication

Path Parameters

Request Body

Response

PATCH vs PUT