Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Workforce Planning

Schedule Positions Cancellation

Schedules the cancellation of one or more positions. This endpoint automatically unassigns any employees connected to the position openings before cancellation.

Note:

  • Cancellation date is optional. If provided, Positions are scheduled to be cancelled at 12:00 AM (midnight) on the specified date. Otherwise, they are cancelled immediately.
  • If scheduled for a future date, the position and its openings will remain in status "Cancelled soon" until cancelled.
  • After cancellation, the status will change to "Cancelled".
  • If a position is `filled`, the employees assigned to the openings will be automatically unassigned before cancellation.

Limitations:

  • Positions that are already canceled cannot be scheduled for cancellation again.
post/workforce-planning/positions/schedule-cancellation

Request body

positionIdsnumber[] required

A list of position IDs to be cancelled. To retrieve position IDs, use the <a href="/reference/post_objects-position-search">Position Search endpoint</a>.

cancellationDatestring date nullable

The date on which the positions should be cancelled (optional). If provided, cancellation will occur at 12:00 AM (midnight) on the specified date. Otherwise, the date defaults to today and the cancellation occurs immediately. In this case, there is no "Cancelled Soon" status; the position goes straight to "Cancelled".

Response

Positions cancellation scheduled successfully