Untuk ejen AI: markdown halaman ini — /docs-content-en/workday/schedules-delete.md indeks dokumentasi — /llms.txt

Artikel dokumentasi kini tersedia dalam bahasa Inggeris.

Delete a schedule

DELETE /v1/workday/schedules/:id

Deletes a work schedule. A deleted schedule cannot be restored through the API. Schedules are created and changed only in the Bitrix24 account interface.

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. Without this permission the credential owner gets 422 BITRIX_ERROR. READONLY keys cannot delete a schedule.

Parameters

Parameter Type Required Default Description
id (path) integer yes — Work schedule ID, a positive integer. Where to get it: the work schedules page of the Bitrix24 account (/timeman/schedules/); the API has no schedule list. Check by ID: GET /v1/workday/schedule

Examples

curl — personal key

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

curl — OAuth application

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

JavaScript — personal key

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

JavaScript — OAuth application

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

Response fields

Field Type Description
success boolean true when the schedule is deleted
data boolean Always true

Response example

JSON 
{
  "success": true,
  "data": true
}

Error response example

404 — no schedule with this id, or it is already deleted:

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

Errors

HTTP Code Description
400 INVALID_PARAMS id is not a positive integer
404 ENTITY_NOT_FOUND No schedule with this id, including after deletion
422 BITRIX_ERROR The credential owner lacks permission to manage work schedules — the Bitrix24 text is in message
403 WRITE_BLOCKED_READONLY_KEY The key is in read-only mode
409 TIMEMAN_MODULE_NOT_ENABLED Time Management is not available on this portal: the Time Management tool is switched off in the portal settings, or the module is not included in the plan
502 BITRIX_UNAVAILABLE Bitrix24 is unavailable or returned a response of an unexpected shape
401 MISSING_API_KEY The X-Api-Key header was not passed
401 TOKEN_MISSING An app key was sent without a session token in Authorization: Bearer
401 INVALID_SESSION The session token is invalid or has expired
403 SCOPE_DENIED The key lacks the timeman scope
429 RATE_LIMITED The general request limit was exceeded; the retry delay is in the Retry-After header

The full list of common API errors — Errors.

Known specifics

A deleted schedule can neither be read nor changed. GET /v1/workday/schedule with its id returns 200 with empty data, while a repeated deletion and operations on schedule members return 404 ENTITY_NOT_FOUND.

See also