Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Deprecation: Management Unit level Time-Off Limits and Time-Off Plans APIs

  • 1.  Deprecation: Management Unit level Time-Off Limits and Time-Off Plans APIs

    Posted 4 hours ago
    Edited by Ananya Singh 4 hours ago

    Summary

    As part of the Staffing Groups for WFM release , Time-Off Limits and Time-Off Plans can now be configured at the Business Unit level in addition to the Management Unit level. Because every Management Unit belongs to a Business Unit, new Business Unit-scoped API routes have been introduced to consolidate this functionality.

    Additionally, as part of the Fifteen-Minute Granularity for Time-Off Limits release, a new route has been added to retrieve time-off limit values with either daily or fifteen-minute granularity. The previous Business Unit-level query route only returns values for limits with daily granularity and is therefore being deprecated in favor of the new, more complete route.

    Effective Date

    Wednesday, July 29, 2026

    Details

    The Management Unit-scoped routes for Time-Off Limits and Time-Off Plans, along with one Business Unit-scoped time-off limit values query route, are being deprecated. Customers should migrate to the new Business Unit-scoped equivalents.The new Business Unit-scoped Time-Off Plan and Time-Off Limit routes allow API consumers to create and manage limits and plans that apply to either a Business Unit or a Management Unit through a single, consistent surface. This is the recommended approach going forward.

    In addition, the new time-off limit values query route scoped to a specific limit, supports both daily and fifteen-minute granularities from a single endpoint, removing the need to use the older BU-level query route that was limited to daily granularity.

    Customer Impact

    Customers currently using the deprecated routes will need to migrate to the replacement Business Unit-scoped routes shown below. No functional capability is lost by migrating. The new new routes support the functionality of deprecated ones in addition to providing additional feature set.

    The deprecated APIs will be removed on October 1st 2026 upon validating and ensuring there are no customer usages.

    Impacted Resources

    Deprecated to Replacement API Mapping

    Deprecated API

    Replacement API

    Time-Off Limits

    GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits

    GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits

    POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits

    POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits

    POST

    /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query

    POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/query

    GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}

    GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}

    DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}

    DELETE

    /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}

    PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values

    PUT

    /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values

    PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}

    None (Its only patchable field (defaultLimitMinutes) is not supported on the new BU routes, and PATCH of time-off limits is no longer allowed.)

    Time-Off Plans

    GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans

    GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans

    POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans

    POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans

    GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}

    GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}

    DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}

    DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}

    PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}

    PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}

    Time-Off Limit Values Query (BU-scoped)

    POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query

    POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/query

    Issue References

    WEM-608

    WEM-866

    Contacts

    @Krishna Raghuraman  @Vidas Placiakis  @Paul Wood  

    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.