Remove an employee from a schedule

DELETE /v1/workday/schedules/:id/users/:userId

Excludes an employee from a work schedule, including a schedule assigned to all employees, and removes their future shifts on this schedule. To bring the employee back to the schedule, add them again.

Requires the timeman scope and permission to manage work schedules in Bitrix24: the Bitrix24 account administrator always has it; an employee is granted it in the Time Management access permission settings. READONLY keys cannot exclude an employee from a schedule. To add an employee to a schedule, see Add an employee to a schedule.

Parameters

Examples

curl — personal key

curl -X DELETE "https://vibecode.bitrix24.com/v1/workday/schedules/13/users/503" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

curl -X DELETE "https://vibecode.bitrix24.com/v1/workday/schedules/13/users/503" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/schedules/13/users/503', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()

JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/workday/schedules/13/users/503', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Response example

{
  "success": true,
  "data": {
    "schedule": {
      "id": 13,
      "name": "Office 5/2"
    }
  }
}

Error response example

404 — no schedule with this id, or it has been deleted:

{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Schedule was not found"
  }
}

Errors

The full list of common API errors — Errors.

Known specifics

Exclusion does not delete the schedule assignment. The employee remains among the assigned employees but is marked as excluded, so the schedule does not apply to them. POST /v1/workday/schedules/:id/users removes the mark.

The employee's other schedules stay unchanged. The exclusion applies only to the schedule identified by id.

See also

• Add an employee to a schedule
• Work schedule
• Delete a schedule
• Workday