Skip to main content
POST
/
companies
/
{companyId}
/
limits
/
disable
Disable limits
curl --request POST \
  --url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/limits/disable \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employees": [
    "e3babcde-0123-4567-89ab-cdef01234567",
    "f4cdef01-2345-6789-abcd-ef0123456789"
  ],
  "categories": [
    "meal",
    "transport"
  ]
}
'
{
  "totalRequested": 500,
  "succeeded": 499,
  "failed": 1,
  "errors": [
    {
      "employeeId": "i7f01234-5678-9012-def0-123456789012",
      "error": {
        "message": "Employee not found"
      }
    }
  ]
}

Overview

This endpoint allows you to disable benefit limits for a list of employees.
  • Current payroll: If no payroll parameter is provided, the limits are disabled immediately for the current payroll cycle.
  • Future payroll: If a payroll parameter is provided (e.g., payroll=2026-05), the limits will be disabled starting from that payroll cycle.
You can specify which categories to disable. If the categories field is omitted, the action applies to all available benefit categories for the specified employees.

Synchronous Response

The operation is performed synchronously. The response includes a summary of success and failure counts, and a detailed list of errors for any employees that failed to process.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

companyId
string<uuid>
required

The company identifier

Query Parameters

payroll
string

The payroll cycle identifier (format YYYY-MM). If not provided, it defaults to the current payroll cycle.

Example:

"2026-05"

Body

application/json
employees
string<uuid>[]
required

List of employee IDs to apply the action to

categories
enum<string>[]
required

List of benefit categories to apply the action to. If omitted, applies to all categories.

Available options:
meal,
transport,
nursery

Response

Limits disabled successfully

totalRequested
integer

Total number of employees in the request

succeeded
integer

Number of employees successfully updated

failed
integer

Number of employees that failed to update

errors
object[]

List of errors for employees that failed to update. Empty if all succeeded.