Summary
We are deploying a fix that corrects an issue where an invalid ActivityCategory value (Unscheduled) could incorrectly appear in certain contexts.
The value Unscheduled is not valid for use in:
- Creating ActivityCodes
- Scheduled activities
It is only valid in the context of adherence or shrinkage calculations.
This will have no effect on any actual APIs, as a 400 Invalid Request would have been thrown if attempting to use this value incorrectly, but it will mean some slight changes to the SDK, in that cases where Unscheduled is valid will have the enum AdherenceActivityCategory rather than ActivityCategory, and ActivityCategory has been modified to remove the invalid value.
Effective Date
Tuesday, July 22, 2025
Details
This update is to improve API accuracy and reduce SDK confusion by:
- Correcting the enum definitions
- Ensuring invalid values are no longer present in inappropriate contexts
Going forward:
- The
Unscheduled value is removed from the ActivityCategory enum
- It is now present only in the
AdherenceActivityCategory enum for adherence- and shrinkage-specific routes
Customer Impact
- No impact on API functionality: Invalid values already resulted in 400 responses
- SDK users may see changes if referencing the ActivityCategory enum directly
- Minimal updates may be needed to support new enum, depending on usage
Impacted Resources
Invalid enum value removed from:
- /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/*
- POST /api/v2/workforcemanagement/businessunits (create business unit schedule notification settings)
- /api/v2/workforcemanagement/businessunits/{businessUnitId} (schedule notification settings)
- POST /api/v2/workforcemanagement/managementunits (create management unit shift trading settings and ignored activity categories for adherence are affected)
- /api/v2/workforcemanagement/managementunits/{managementUnitId} (shift trading settings and ignored activity categories for adherence are affected)
- All schedule related routes that return agent shift activity details
Enum name change:
HIstorical Adherence (in download result schema)
- /api/v2/workforcemanagement/adherence/historical/*
Real Time Adherence
- GET /api/v2/workforcemanagement/adherence
- GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence
- GET /api/v2/workforcemanagement/teams/{teamId}/adherence
Historical Shrinkage (in download result schema)
- POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs
- GET /api/v2/workforcemanagement/shrinkage/jobs/{jobId}
- POST /api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs
Issue References
[WFM-26936]
Contacts
@Brian Trezise 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.