Summary
We are announcing the deprecation of several Workforce Management (WFM) API routes. These routes were originally marked as deprecated in October 2020, with the initial announcement posted on the legacy Genesys Developer Forum. This announcement serves as a formal reminder and provides migration guidance.
Removal will occur on or after January 4, 2027, subject to zero usage being observed.
Effective Date
Thursday, May 28, 2026
Additional Resources
A full migration guide for all affected routes can be found here:
Migration Guide
Details
Key Migration Notes
Obtaining Business Unit IDs
Most deprecated routes are management unit scoped. Replacements are business unit scoped. To get your business unit ID:
GET /api/v2/workforcemanagement/managementunits/{muId}
The response includes businessUnit.id.
Response Format Changes
|
Old Format
|
New Format
|
|
lengthInMinutes
|
lengthMinutes
|
|
countsAsPaidTime
|
paid
|
|
userSchedules
|
agentSchedules
|
Async Processing
New routes support asynchronous processing for large datasets. Be prepared to handle responses with status: "Processing" and listen for completion notifications.
Timeline
|
Date
|
Action
|
|
October 2020
|
Routes originally marked as deprecated (announced on legacy Developer Forum)
|
|
May 2026
|
This deprecation announcement with migration guides
|
|
January 4, 2027
|
Planned removal (subject to zero usage)
|
Migration Resources
The full migration guide can be found here. Additionally, direct links to the migration guide for each individual affected route are linked in the table below.
Each guide includes:
- Step-by-step migration instructions
- Request/response schema changes
- Code examples in TypeScript and Java
- Permission requirements
Customer Impact
Affected customers will need to follow the migration guide for any routes they are using.
Impacted Resources
|
Deprecated Route
|
Replacement
|
Migration Guide
|
|
GET /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
|
GET /api/v2/workforcemanagement/businessunits/{buId}/activitycodes
|
Activity Codes
|
|
GET /api/v2/workforcemanagement/managementunits/{muId}/weeks/{weekId}/schedules
|
GET /api/v2/workforcemanagement/businessunits/{buId}/weeks/{weekId}/schedules
|
Week Schedule List
|
|
GET /api/v2/workforcemanagement/managementunits/{muId}/weeks/{weekId}/schedules/{scheduleId}
|
GET /api/v2/workforcemanagement/businessunits/{buId}/weeks/{weekId}/schedules/{scheduleId}
|
Single Week Schedule
|
|
POST /api/v2/workforcemanagement/managementunits/{muId}/schedules/search
|
POST /api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search
|
Schedule Search
|
|
POST /api/v2/workforcemanagement/schedules
|
POST /api/v2/workforcemanagement/agentschedules/mine
|
My Schedule
|
Explanation
The switchover to business units happened back in 2020, and most of the legacy routes were removed at that time. The routes affected by this announcement were actively in use by customers, so we grandfathered these routes temporarily to give customers time to switch to the new routes
Issue References
Contacts
@Brian Trezise @Joe Behymer
Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.