Request Schedule Adherence Job

Description

Submits a request to run a bulk historical adherence job for specified management units and date range.

Business Application

Enables Workforce Management (WFM) teams to track how well agents adhere to their assigned schedules (e.g., breaks, lunch). High adherence correlates with reliable Service Levels.

Endpoint

POST https://api.mypurecloud.de/api/v2/workforcemanagement/adherence/historical/bulk

Request

Headers

Authorization: Bearer Token
Content-Type: application/json

Body Parameters

Name	Type	Mandatory	Description
`items`	Array	Yes	List of management units and date ranges
`timeZone`	String	Yes	Time zone for the request (e.g., "Asia/Riyadh")

Items Object Properties:

Name	Type	Mandatory	Description
`startDate`	DateTime	Yes	Start time for the query. Dynamic: Use Start of Week (e.g. Monday).
`endDate`	DateTime	Yes	End time for the query. Dynamic: Use End of Week (e.g. Sunday).
`managementUnitId`	String	Yes	ID of the unit being queried. Retrieve dynamically using Get Management Unit IDs.

Sample Request

{
  "items": [
    {
      "startDate": "2025-11-22T22:00:00.000Z",
      "endDate": "2025-11-29T22:00:00.000Z",
      "managementUnitId": "<MANAGEMENT_UNIT_ID>"
    }
  ],
  "timeZone": "Asia/Riyadh"
}

CURL Example

curl -X POST 'https://api.mypurecloud.de/api/v2/workforcemanagement/adherence/historical/bulk' \
  -H 'Authorization: Bearer *******************' \
  -H 'Content-Type: application/json' \
  --data-raw $'{"items":[{"startDate":"2025-11-22T22:00:00.000Z","endDate":"2025-11-29T22:00:00.000Z","managementUnitId":"<MANAGEMENT_UNIT_ID>"}],"timeZone":"Asia/Riyadh"}'

Response

Body Parameters

Name	Type	Description
`job`	Object	Contains details of the created job
`downloadUrls`	Array	URLs to download the results

Sample Response

{
    "job": {
        "id": "<JOB_ID>",
        "status": "Processing",
        "selfUri": "/api/v2/workforcemanagement/adherence/historical/bulk/jobs/<JOB_ID>"
    },
    "downloadUrls": []
}