Genesys Cloud – Deprecation: Management unit level time-off limits and time-off plans APIs
Genesys Cloud will deprecate the management unit-scoped time-off limits and time-off plans API routes and the business unit-scoped time-off limit values query route.
The business unit-scoped time-off limits and time-off plans API routes provide a single, consistent way to create and manage time-off limits and plans that apply to either a business unit or management unit. In addition, the new limit-specific time-off limit values query supports both daily and 15-minute granularities.
Customers who use the deprecated API routes must migrate to the corresponding business unit-scoped routes.
FAQs
Am I affected?
This deprecation affects customers who use the following management unit-scoped time-off limits and time-off plans API routes:
Time-off limits:
- GET – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits
- POST – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits
- POST – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query
- GET – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
- DELETE – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
- PUT – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values
- PATCH – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
Time-off plans:
- GET – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans
- POST – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans
- GET – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
- DELETE – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
- PATCH – /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}
This deprecation also affects customers who use the following business unit-scoped time-off limit values query:
- POST – /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query
How can I prepare for this deprecation?
Review your integrations and scripts for calls to the deprecated API routes and migrate them to the corresponding business unit-scoped routes.
For time-off limits and time-off plans, use the business unit-scoped API routes under:
- /api/v2/workforcemanagement/businessunits/{businessUnitId}/…
If you use:
- POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query
migrate to:
- POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/query
The replacement query supports both daily and 15-minute granularities.
If your integration uses the following API, then remove the API call from your integration. This API has no business unit-scoped replacement. The defaultLimitMinutes field is not supported on the new business unit-scoped routes, and PATCH operations for time-off limits are no longer supported.
- PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}
What if I need help or have questions?
Contact My Support.
[NEXT] Was this article helpful?
Get user feedback about articles.