> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # genesys-workforce > Genesys Workforce Management - management units, adherence, schedules, time-off, shift trades, and work plans **Server path:** `/genesys-workforce` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | [`genesys_workforce_delete_managementunit`](#genesys_workforce_delete_managementunit) | Delete management unit | | [`genesys_workforce_delete_managementunit_timeofflimit`](#genesys_workforce_delete_managementunit_timeofflimit) | Deletes a time off limit object | | [`genesys_workforce_delete_managementunit_timeoffplan`](#genesys_workforce_delete_managementunit_timeoffplan) | Deletes a time off plan | | [`genesys_workforce_delete_managementunit_workplan`](#genesys_workforce_delete_managementunit_workplan) | Delete a work plan | | [`genesys_workforce_delete_managementunit_workplanrotation`](#genesys_workforce_delete_managementunit_workplanrotation) | Delete a work plan rotation | | [`genesys_workforce_get_adherence`](#genesys_workforce_get_adherence) | Get a list of UserScheduleAdherence records for the requested users | | [`genesys_workforce_get_adherence_explanation`](#genesys_workforce_get_adherence_explanation) | Get an adherence explanation for the current user | | [`genesys_workforce_get_adherence_explanations_job`](#genesys_workforce_get_adherence_explanations_job) | Query the status of an adherence explanation operation. Only the user who started the operation can query the status | | [`genesys_workforce_get_adherence_historical_job`](#genesys_workforce_get_adherence_historical_job) | Query the status of a historical adherence request operation. Only the user who started the operation can query the status | | [`genesys_workforce_get_agent_adherence_explanation`](#genesys_workforce_get_agent_adherence_explanation) | Get an adherence explanation | | [`genesys_workforce_get_agent_managementunit`](#genesys_workforce_get_agent_managementunit) | Get the management unit to which the agent belongs | | [`genesys_workforce_get_agents_me_adherence_historical_job`](#genesys_workforce_get_agents_me_adherence_historical_job) | Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status | | [`genesys_workforce_get_agents_me_managementunit`](#genesys_workforce_get_agents_me_managementunit) | Get the management unit to which the currently logged in agent belongs | | [`genesys_workforce_get_managementunit`](#genesys_workforce_get_managementunit) | Get management unit | | [`genesys_workforce_get_managementunit_adherence`](#genesys_workforce_get_managementunit_adherence) | Get a list of user schedule adherence records for the requested management unit | | [`genesys_workforce_get_managementunit_agent`](#genesys_workforce_get_managementunit_agent) | Get data for agent in the management unit | | [`genesys_workforce_get_managementunit_agent_shifttrades`](#genesys_workforce_get_managementunit_agent_shifttrades) | Gets all the shift trades for a given agent | | [`genesys_workforce_get_managementunit_shifttrades_matched`](#genesys_workforce_get_managementunit_shifttrades_matched) | Gets a summary of all shift trades in the matched state | | [`genesys_workforce_get_managementunit_shifttrades_users`](#genesys_workforce_get_managementunit_shifttrades_users) | Gets list of users available for whom you can send direct shift trade requests | | [`genesys_workforce_get_managementunit_timeofflimit`](#genesys_workforce_get_managementunit_timeofflimit) | Gets a time off limit object | | [`genesys_workforce_get_managementunit_timeofflimits`](#genesys_workforce_get_managementunit_timeofflimits) | Gets a list of time off limit objects under management unit. | | [`genesys_workforce_get_managementunit_timeoffplan`](#genesys_workforce_get_managementunit_timeoffplan) | Gets a time off plan | | [`genesys_workforce_get_managementunit_timeoffplans`](#genesys_workforce_get_managementunit_timeoffplans) | Gets a list of time off plans | | [`genesys_workforce_get_managementunit_user_timeoffrequest`](#genesys_workforce_get_managementunit_user_timeoffrequest) | Get a time off request | | [`genesys_workforce_get_managementunit_user_timeoffrequest_timeofflimits`](#genesys_workforce_get_managementunit_user_timeoffrequest_timeofflimits) | Retrieves time off limit, allocated and waitlisted values according to specific time off request | | [`genesys_workforce_get_managementunit_user_timeoffrequests`](#genesys_workforce_get_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user | | [`genesys_workforce_get_managementunit_users`](#genesys_workforce_get_managementunit_users) | Get users in the management unit | | [`genesys_workforce_get_managementunit_week_shifttrades`](#genesys_workforce_get_managementunit_week_shifttrades) | Gets all the shift trades for a given week | | [`genesys_workforce_get_managementunit_workplan`](#genesys_workforce_get_managementunit_workplan) | Get a work plan | | [`genesys_workforce_get_managementunit_workplanrotation`](#genesys_workforce_get_managementunit_workplanrotation) | Get a work plan rotation | | [`genesys_workforce_get_managementunit_workplanrotations`](#genesys_workforce_get_managementunit_workplanrotations) | Get work plan rotations | | [`genesys_workforce_get_managementunit_workplans`](#genesys_workforce_get_managementunit_workplans) | Get work plans | | [`genesys_workforce_get_managementunits`](#genesys_workforce_get_managementunits) | Get management units | | [`genesys_workforce_get_notifications`](#genesys_workforce_get_notifications) | Get a list of notifications for the current user | | [`genesys_workforce_get_shifttrades`](#genesys_workforce_get_shifttrades) | Gets all of my shift trades | | [`genesys_workforce_get_team_adherence`](#genesys_workforce_get_team_adherence) | Get a list of user schedule adherence records for the requested team | | [`genesys_workforce_get_timeoffbalance_job`](#genesys_workforce_get_timeoffbalance_job) | Query the results of time off types job | | [`genesys_workforce_get_timeoffrequest`](#genesys_workforce_get_timeoffrequest) | Get a time off request for the current user | | [`genesys_workforce_get_timeoffrequest_waitlistpositions`](#genesys_workforce_get_timeoffrequest_waitlistpositions) | Get the daily waitlist positions of a time off request for the current user | | [`genesys_workforce_get_timeoffrequests`](#genesys_workforce_get_timeoffrequests) | Get a list of time off requests for the current user | | [`genesys_workforce_get_workforcemanagement_adherence`](#genesys_workforce_get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users | | [`genesys_workforce_get_workforcemanagement_managementunit`](#genesys_workforce_get_workforcemanagement_managementunit) | Get management unit | | [`genesys_workforce_get_workforcemanagement_managementunit_adherence`](#genesys_workforce_get_workforcemanagement_managementunit_adherence) | Get a list of user schedule adherence records for the requested management unit | | [`genesys_workforce_get_workforcemanagement_managementunit_agent`](#genesys_workforce_get_workforcemanagement_managementunit_agent) | Get data for agent in the management unit | | [`genesys_workforce_get_workforcemanagement_managementunit_user_timeoffrequests`](#genesys_workforce_get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for a given user | | [`genesys_workforce_get_workforcemanagement_managementunit_users`](#genesys_workforce_get_workforcemanagement_managementunit_users) | Get users in the management unit | | [`genesys_workforce_get_workforcemanagement_managementunits`](#genesys_workforce_get_workforcemanagement_managementunits) | Get management units | | [`genesys_workforce_get_workforcemanagement_notifications`](#genesys_workforce_get_workforcemanagement_notifications) | Get a list of notifications for the current user | | [`genesys_workforce_get_workforcemanagement_team_adherence`](#genesys_workforce_get_workforcemanagement_team_adherence) | Get a list of user schedule adherence records for the requested team | | [`genesys_workforce_get_workforcemanagement_timeoffrequest`](#genesys_workforce_get_workforcemanagement_timeoffrequest) | Get a time off request for the current user | | [`genesys_workforce_get_workforcemanagement_timeoffrequests`](#genesys_workforce_get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user | | [`genesys_workforce_patch_agent_adherence_explanation`](#genesys_workforce_patch_agent_adherence_explanation) | Update an adherence explanation | | [`genesys_workforce_patch_managementunit`](#genesys_workforce_patch_managementunit) | Update the requested management unit | | [`genesys_workforce_patch_managementunit_agents`](#genesys_workforce_patch_managementunit_agents) | Update agent configurations | | [`genesys_workforce_patch_managementunit_timeofflimit`](#genesys_workforce_patch_managementunit_timeofflimit) | Updates a time off limit object. | | [`genesys_workforce_patch_managementunit_timeoffplan`](#genesys_workforce_patch_managementunit_timeoffplan) | Updates a time off plan | | [`genesys_workforce_patch_managementunit_timeoffrequest_user_integrationstatus`](#genesys_workforce_patch_managementunit_timeoffrequest_user_integrationstatus) | Set integration status for a time off request. | | [`genesys_workforce_patch_managementunit_user_timeoffrequest`](#genesys_workforce_patch_managementunit_user_timeoffrequest) | Update a time off request | | [`genesys_workforce_patch_managementunit_week_shifttrade`](#genesys_workforce_patch_managementunit_week_shifttrade) | Updates a shift trade. This route can only be called by the initiating agent | | [`genesys_workforce_patch_managementunit_workplan`](#genesys_workforce_patch_managementunit_workplan) | Update a work plan | | [`genesys_workforce_patch_managementunit_workplanrotation`](#genesys_workforce_patch_managementunit_workplanrotation) | Update a work plan rotation | | [`genesys_workforce_patch_timeoffrequest`](#genesys_workforce_patch_timeoffrequest) | Update a time off request for the current user | | [`genesys_workforce_post_adherence_explanations`](#genesys_workforce_post_adherence_explanations) | Submit an adherence explanation for the current user | | [`genesys_workforce_post_adherence_explanations_query`](#genesys_workforce_post_adherence_explanations_query) | Query adherence explanations for the current user | | [`genesys_workforce_post_agent_adherence_explanations`](#genesys_workforce_post_agent_adherence_explanations) | Add an adherence explanation for the requested user | | [`genesys_workforce_post_agent_adherence_explanations_query`](#genesys_workforce_post_agent_adherence_explanations_query) | Query adherence explanations for the given agent across a specified range | | [`genesys_workforce_post_agents`](#genesys_workforce_post_agents) | Move agents in and out of management unit | | [`genesys_workforce_post_agents_me_adherence_historical_jobs`](#genesys_workforce_post_agents_me_adherence_historical_jobs) | Request an agent historical adherence report | | [`genesys_workforce_post_agents_me_possibleworkshifts`](#genesys_workforce_post_agents_me_possibleworkshifts) | Get agent possible work shifts for requested time frame | | [`genesys_workforce_post_agentschedules_managementunits_mine`](#genesys_workforce_post_agentschedules_managementunits_mine) | Fetch agent schedules for the logged in user's management unit | | [`genesys_workforce_post_agentschedules_mine`](#genesys_workforce_post_agentschedules_mine) | Get published schedule for the current user | | [`genesys_workforce_post_managementunit_agents_workplans_query`](#genesys_workforce_post_managementunit_agents_workplans_query) | Get agents work plans configuration | | [`genesys_workforce_post_managementunit_agentschedules_search`](#genesys_workforce_post_managementunit_agentschedules_search) | Query published schedules for given given time range for set of users | | [`genesys_workforce_post_managementunit_historicaladherencequery`](#genesys_workforce_post_managementunit_historicaladherencequery) | Request a historical adherence report | | [`genesys_workforce_post_managementunit_move`](#genesys_workforce_post_managementunit_move) | Move the requested management unit to a new business unit | | [`genesys_workforce_post_managementunit_timeofflimits`](#genesys_workforce_post_managementunit_timeofflimits) | Creates a new time off limit object under management unit. | | [`genesys_workforce_post_managementunit_timeofflimits_values_query`](#genesys_workforce_post_managementunit_timeofflimits_values_query) | Retrieves time off limit related values based on a given set of filters. | | [`genesys_workforce_post_managementunit_timeoffplans`](#genesys_workforce_post_managementunit_timeoffplans) | Creates a new time off plan | | [`genesys_workforce_post_managementunit_timeoffrequests`](#genesys_workforce_post_managementunit_timeoffrequests) | Create a new time off request | | [`genesys_workforce_post_managementunit_timeoffrequests_integrationstatus_query`](#genesys_workforce_post_managementunit_timeoffrequests_integrationstatus_query) | Retrieves integration statuses for a list of time off requests | | [`genesys_workforce_post_managementunit_timeoffrequests_query`](#genesys_workforce_post_managementunit_timeoffrequests_query) | Fetches time off requests matching the conditions specified in the request body | | [`genesys_workforce_post_managementunit_timeoffrequests_waitlistpositions_query`](#genesys_workforce_post_managementunit_timeoffrequests_waitlistpositions_query) | Retrieves daily waitlist position for a list of time off requests | | [`genesys_workforce_post_managementunit_user_timeoffbalance_jobs`](#genesys_workforce_post_managementunit_user_timeoffbalance_jobs) | Query time off balances for a given user for specified activity code and dates | | [`genesys_workforce_post_managementunit_user_timeoffrequest_timeoffbalance_jobs`](#genesys_workforce_post_managementunit_user_timeoffrequest_timeoffbalance_jobs) | Query time off balances for dates spanned by a given time off request | | [`genesys_workforce_post_managementunit_user_timeoffrequests_estimate`](#genesys_workforce_post_managementunit_user_timeoffrequests_estimate) | Estimates available time off for an agent | | [`genesys_workforce_post_managementunit_week_shifttrade_match`](#genesys_workforce_post_managementunit_week_shifttrade_match) | Matches a shift trade. This route can only be called by the receiving agent | | [`genesys_workforce_post_managementunit_week_shifttrades`](#genesys_workforce_post_managementunit_week_shifttrades) | Adds a shift trade | | [`genesys_workforce_post_managementunit_week_shifttrades_search`](#genesys_workforce_post_managementunit_week_shifttrades_search) | Searches for potential shift trade matches for the current agent | | [`genesys_workforce_post_managementunit_workplan_copy`](#genesys_workforce_post_managementunit_workplan_copy) | Create a copy of work plan | | [`genesys_workforce_post_managementunit_workplan_validate`](#genesys_workforce_post_managementunit_workplan_validate) | Validate Work Plan | | [`genesys_workforce_post_managementunit_workplanrotation_copy`](#genesys_workforce_post_managementunit_workplanrotation_copy) | Create a copy of work plan rotation | | [`genesys_workforce_post_managementunit_workplanrotations`](#genesys_workforce_post_managementunit_workplanrotations) | Create a new work plan rotation | | [`genesys_workforce_post_managementunit_workplans`](#genesys_workforce_post_managementunit_workplans) | Create a new work plan | | [`genesys_workforce_post_managementunits`](#genesys_workforce_post_managementunits) | Add a management unit | | [`genesys_workforce_post_notifications_update`](#genesys_workforce_post_notifications_update) | Mark a list of notifications as read or unread | | [`genesys_workforce_post_team_adherence_historical`](#genesys_workforce_post_team_adherence_historical) | Request a teams historical adherence report | | [`genesys_workforce_post_timeoffbalance_jobs`](#genesys_workforce_post_timeoffbalance_jobs) | Query time off balances for the current user for specified activity code and dates | | [`genesys_workforce_post_timeofflimits_available_query`](#genesys_workforce_post_timeofflimits_available_query) | Queries available time off for the current user | | [`genesys_workforce_post_timeoffrequests`](#genesys_workforce_post_timeoffrequests) | Create a time off request for the current user | | [`genesys_workforce_post_timeoffrequests_estimate`](#genesys_workforce_post_timeoffrequests_estimate) | Estimates available time off for current user | | [`genesys_workforce_post_timeoffrequests_integrationstatus_query`](#genesys_workforce_post_timeoffrequests_integrationstatus_query) | Retrieves integration statuses for a list of current user time off requests | | [`genesys_workforce_post_workforcemanagement_agentschedules_mine`](#genesys_workforce_post_workforcemanagement_agentschedules_mine) | Get published schedule for the current user | | [`genesys_workforce_post_workforcemanagement_managementunit_agentschedules_search`](#genesys_workforce_post_workforcemanagement_managementunit_agentschedules_search) | Query published schedules for given given time range for set of users | | [`genesys_workforce_post_workforcemanagement_managementunit_timeoffrequests_query`](#genesys_workforce_post_workforcemanagement_managementunit_timeoffrequests_query) | Fetches time off requests matching the conditions specified in the request body | | [`genesys_workforce_post_workforcemanagement_timeoffrequests`](#genesys_workforce_post_workforcemanagement_timeoffrequests) | Create a time off request for the current user | | [`genesys_workforce_put_managementunit_timeofflimit_values`](#genesys_workforce_put_managementunit_timeofflimit_values) | Sets daily values for a date range of time off limit object | *** ## genesys\_workforce\_delete\_managementunit Delete management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_delete\_managementunit\_timeofflimit Deletes a time off limit object **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffLimitId` | string | Yes | — | The ID of the time off limit object to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffLimitId": { "type": "string", "description": "The ID of the time off limit object to delete" } }, "required": [ "PCID", "managementUnitId", "timeOffLimitId" ] } ``` *** ## genesys\_workforce\_delete\_managementunit\_timeoffplan Deletes a time off plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `timeOffPlanId` | string | Yes | — | The ID of the time off plan to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "timeOffPlanId": { "type": "string", "description": "The ID of the time off plan to delete" } }, "required": [ "PCID", "managementUnitId", "timeOffPlanId" ] } ``` *** ## genesys\_workforce\_delete\_managementunit\_workplan Delete a work plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanId` | string | Yes | — | The ID of the work plan to delete | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanId": { "type": "string", "description": "The ID of the work plan to delete" } }, "required": [ "PCID", "managementUnitId", "workPlanId" ] } ``` *** ## genesys\_workforce\_delete\_managementunit\_workplanrotation Delete a work plan rotation **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanRotationId` | string | Yes | — | The ID of the work plan rotation to be deleted | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanRotationId": { "type": "string", "description": "The ID of the work plan rotation to be deleted" } }, "required": [ "PCID", "managementUnitId", "workPlanRotationId" ] } ``` *** ## genesys\_workforce\_get\_adherence Get a list of UserScheduleAdherence records for the requested users **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `userId` | string\[] | Yes | — | User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "array", "items": { "type": "string" }, "description": "User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request" } }, "required": [ "PCID", "userId" ] } ``` *** ## genesys\_workforce\_get\_adherence\_explanation Get an adherence explanation for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `explanationId` | string | Yes | — | The ID of the explanation to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "explanationId": { "type": "string", "description": "The ID of the explanation to update" } }, "required": [ "PCID", "explanationId" ] } ``` *** ## genesys\_workforce\_get\_adherence\_explanations\_job Query the status of an adherence explanation operation. Only the user who started the operation can query the status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `jobId` | string | Yes | — | The ID of the job | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The ID of the job" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_workforce\_get\_adherence\_historical\_job Query the status of a historical adherence request operation. Only the user who started the operation can query the status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `jobId` | string | Yes | — | Job Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "Job Id" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_workforce\_get\_agent\_adherence\_explanation Get an adherence explanation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ----------------------------------- | | `agentId` | string | Yes | — | The ID of the agent to query | | `explanationId` | string | Yes | — | The ID of the explanation to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The ID of the agent to query" }, "explanationId": { "type": "string", "description": "The ID of the explanation to update" } }, "required": [ "PCID", "agentId", "explanationId" ] } ``` *** ## genesys\_workforce\_get\_agent\_managementunit Get the management unit to which the agent belongs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------ | | `agentId` | string | Yes | — | The ID of the agent to look up | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The ID of the agent to look up" } }, "required": [ "PCID", "agentId" ] } ``` *** ## genesys\_workforce\_get\_agents\_me\_adherence\_historical\_job Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------------- | | `jobId` | string | Yes | — | ID of the job to get | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "ID of the job to get" } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_workforce\_get\_agents\_me\_managementunit Get the management unit to which the currently logged in agent belongs ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_managementunit Get management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "settings", "settings.adherence", "settings.timeOff", "settings.scheduling", "settings.shortTermForecasting", "settings.shiftTrading" ] }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_adherence Get a list of user schedule adherence records for the requested management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_agent Get data for agent in the management unit **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `agentId` | string | Yes | — | The agent id | | `excludeCapabilities` | boolean | No | — | Excludes all capabilities of the agent such as queues, languages, and skills | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "agentId": { "type": "string", "description": "The agent id" }, "excludeCapabilities": { "type": "boolean", "description": "Excludes all capabilities of the agent such as queues, languages, and skills" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "workPlanOverrides" ] }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "managementUnitId", "agentId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_agent\_shifttrades Gets all the shift trades for a given agent **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `agentId` | string | Yes | — | The agent id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "agentId": { "type": "string", "description": "The agent id" } }, "required": [ "PCID", "managementUnitId", "agentId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_shifttrades\_matched Gets a summary of all shift trades in the matched state **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_shifttrades\_users Gets list of users available for whom you can send direct shift trade requests **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_timeofflimit Gets a time off limit object **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffLimitId` | string | Yes | — | The ID of the time off limit to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffLimitId": { "type": "string", "description": "The ID of the time off limit to fetch" } }, "required": [ "PCID", "managementUnitId", "timeOffLimitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_timeofflimits Gets a list of time off limit objects under management unit. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_timeoffplan Gets a time off plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `timeOffPlanId` | string | Yes | — | The ID of the time off plan to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "timeOffPlanId": { "type": "string", "description": "The ID of the time off plan to fetch" } }, "required": [ "PCID", "managementUnitId", "timeOffPlanId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_timeoffplans Gets a list of time off plans **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ----------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_user\_timeoffrequest Get a time off request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `userId` | string | Yes | — | The userId to whom the Time Off Request applies. | | `timeOffRequestId` | string | Yes | — | Time Off Request Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "userId": { "type": "string", "description": "The userId to whom the Time Off Request applies." }, "timeOffRequestId": { "type": "string", "description": "Time Off Request Id" } }, "required": [ "PCID", "managementUnitId", "userId", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_user\_timeoffrequest\_timeofflimits Retrieves time off limit, allocated and waitlisted values according to specific time off request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `userId` | string | Yes | — | The userId to whom the time off request applies. | | `timeOffRequestId` | string | Yes | — | The ID of the time off request, which dates and activityCodeId determine limit values to retrieve | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "userId": { "type": "string", "description": "The userId to whom the time off request applies." }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request, which dates and activityCodeId determine limit values to retrieve" } }, "required": [ "PCID", "managementUnitId", "userId", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_user\_timeoffrequests Get a list of time off requests for a given user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `userId` | string | Yes | — | The userId to whom the Time Off Request applies. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "userId": { "type": "string", "description": "The userId to whom the Time Off Request applies." } }, "required": [ "PCID", "managementUnitId", "userId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_users Get users in the management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_week\_shifttrades Gets all the shift trades for a given week **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `weekDateId` | string | Yes | — | The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `evaluateMatches` | boolean | No | — | Whether to evaluate the matches for violations | | `includeCrossWeekShifts` | boolean | No | — | Whether to include all shift trades with either the initiating shift or the receiving shift in the week | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "weekDateId": { "type": "string", "description": "The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "evaluateMatches": { "type": "boolean", "description": "Whether to evaluate the matches for violations" }, "includeCrossWeekShifts": { "type": "boolean", "description": "Whether to include all shift trades with either the initiating shift or the receiving shift in the week" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } }, "required": [ "PCID", "managementUnitId", "weekDateId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_workplan Get a work plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanId` | string | Yes | — | The ID of the work plan to fetch | | `includeOnly` | string\[] | No | — | limit response to the specified fields | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanId": { "type": "string", "description": "The ID of the work plan to fetch" }, "includeOnly": { "type": "array", "items": { "type": "string", "enum": [ "agentCount", "agents", "optionalDays", "shifts", "shiftStartVariances" ] }, "description": "limit response to the specified fields" } }, "required": [ "PCID", "managementUnitId", "workPlanId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_workplanrotation Get a work plan rotation **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanRotationId` | string | Yes | — | The ID of the work plan rotation to fetch | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanRotationId": { "type": "string", "description": "The ID of the work plan rotation to fetch" } }, "required": [ "PCID", "managementUnitId", "workPlanRotationId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_workplanrotations Get work plan rotations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `expand` | string\[] | No | — | Related resources to expand inline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "agents" ] }, "description": "Related resources to expand inline" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunit\_workplans Get work plans **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `expand` | string\[] | No | — | Include to access additional data on the work plans | | `exclude` | string\[] | No | — | Exclude specific data on the work plans from the response | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "agentCount", "agents", "optionalDays", "shifts", "shiftStartVariances", "details" ] }, "description": "Include to access additional data on the work plans" }, "exclude": { "type": "array", "items": { "type": "string", "enum": [ "shifts.activities" ] }, "description": "Exclude specific data on the work plans from the response" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_managementunits Get management units **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `pageSize` | integer | No | — | Deprecated, paging is not supported | | `pageNumber` | integer | No | — | Deprecated, paging is not supported | | `expand` | string | No | — | Deprecated, expand settings on the single MU route | | `feature` | string | No | — | If specified, the list of management units for which the user is authorized to use the requested feature will be returned | | `divisionId` | string | No | — | If specified, the list of management units belonging to the specified division will be returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Deprecated, paging is not supported" }, "pageNumber": { "type": "integer", "description": "Deprecated, paging is not supported" }, "expand": { "type": "string", "description": "Deprecated, expand settings on the single MU route", "enum": [ "details" ] }, "feature": { "type": "string", "description": "If specified, the list of management units for which the user is authorized to use the requested feature will be returned", "enum": [ "AgentHistoricalAdherence", "AgentHistoricalAdherenceConformance", "AgentSchedule", "AgentAdherenceAdjustments", "AgentTimeOffRequest", "AgentWorkPlanBid", "AgentScheduleBid", "AgentShiftTrade", "AlternativeShift", "Coaching", "Learning", "AgentUnavailableTimes", "AgentSelfScheduleJob", "AgentSelfScheduleOffers", "AgentSelfScheduleQuery", "AgentSelfScheduleActivityMove", "SelfScheduleSettings", "AgentSelfScheduleSettings", "AgentOpportunitiesQuery", "AgentOpportunitiesEnrollments", "AgentOpportunitiesEnrollmentsStatuses", "AgentSchedulingPreferencesQuery", "AgentSchedulingPreferences", "AgentSchedulingPreferencesSettings", "ActivityCodes", "ActivityPlans", "AdherenceAdjustmentsSettings", "AdherenceAdjustmentsReasonCodes", "AdherenceAdjustments", "UnavailableTimes", "Agents", "BuActivityCodes", "BusinessUnits", "CapacityPlan", "CapacityPlanForecastInputs", "CapacityPlanPerformancePrediction", "ContinuousForecast", "HistoricalAdherence", "HistoricalShrinkage", "IntradayMonitoring", "BuIntradayMonitoring", "ManagementUnits", "RealTimeAdherence", "Schedules", "BuSchedules", "ServiceGoalTemplates", "PlanningGroups", "LongTermStaffing", "ShiftTrading", "ShortTermForecasts", "BuShortTermForecasts", "StaffingGroups", "TimeOffPlans", "TimeOffRequests", "TimeOffLimits", "WorkPlanBids", "WorkPlanBidGroups", "WorkPlanRotations", "WorkPlans", "ScheduleBid", "ScheduleBidGroup", "Opportunities", "OpportunitiesQuery", "OpportunitiesEnrollmentsQuery", "OpportunitiesExternalActivitiesQuery", "OpportunitiesStatuses", "OpportunitiesEnrollmentsStatuses", "SchedulingPreferencesQuery", "SchedulingPreferencesSettings", "DecisionMetrics" ] }, "divisionId": { "type": "string", "description": "If specified, the list of management units belonging to the specified division will be returned" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_notifications Get a list of notifications for the current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_shifttrades Gets all of my shift trades ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_team\_adherence Get a list of user schedule adherence records for the requested team **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `teamId` | string | Yes | — | The ID of the team | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "string", "description": "The ID of the team" } }, "required": [ "PCID", "teamId" ] } ``` *** ## genesys\_workforce\_get\_timeoffbalance\_job Query the results of time off types job **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `jobId` | string | Yes | — | The ID of the job. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "jobId": { "type": "string", "description": "The ID of the job." } }, "required": [ "PCID", "jobId" ] } ``` *** ## genesys\_workforce\_get\_timeoffrequest Get a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------ | | `timeOffRequestId` | string | Yes | — | The ID of the time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request" } }, "required": [ "PCID", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_get\_timeoffrequest\_waitlistpositions Get the daily waitlist positions of a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------ | | `timeOffRequestId` | string | Yes | — | The ID of the time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request" } }, "required": [ "PCID", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_get\_timeoffrequests Get a list of time off requests for the current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_adherence Get a list of UserScheduleAdherence records for the requested users **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------ | | `userId` | any\[] | Yes | — | User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "userId": { "type": "array", "description": "User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request" } }, "required": [ "PCID", "userId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunit Get management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `expand` | any\[] | No | — | expand | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "expand": { "type": "array", "description": "expand" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunit\_adherence Get a list of user schedule adherence records for the requested management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunit\_agent Get data for agent in the management unit **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `agentId` | string | Yes | — | The agent id | | `excludeCapabilities` | boolean | No | — | Excludes all capabilities of the agent such as queues, languages, and skills | | `expand` | any\[] | No | — | expand | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "agentId": { "type": "string", "description": "The agent id" }, "excludeCapabilities": { "type": "boolean", "description": "Excludes all capabilities of the agent such as queues, languages, and skills" }, "expand": { "type": "array", "description": "expand" } }, "required": [ "PCID", "managementUnitId", "agentId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunit\_user\_timeoffrequests Get a list of time off requests for a given user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `userId` | string | Yes | — | The userId to whom the Time Off Request applies. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "userId": { "type": "string", "description": "The userId to whom the Time Off Request applies." } }, "required": [ "PCID", "managementUnitId", "userId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunit\_users Get users in the management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_managementunits Get management units **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | | `pageSize` | integer | No | — | Deprecated, paging is not supported | | `pageNumber` | integer | No | — | Deprecated, paging is not supported | | `expand` | string | No | — | Deprecated, expand settings on the single MU route | | `feature` | string | No | — | If specified, the list of management units for which the user is authorized to use the requested feature will be returned | | `divisionId` | string | No | — | If specified, the list of management units belonging to the specified division will be returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pageSize": { "type": "integer", "description": "Deprecated, paging is not supported" }, "pageNumber": { "type": "integer", "description": "Deprecated, paging is not supported" }, "expand": { "type": "string", "description": "Deprecated, expand settings on the single MU route", "enum": [ "details" ] }, "feature": { "type": "string", "description": "If specified, the list of management units for which the user is authorized to use the requested feature will be returned", "enum": [ "AgentHistoricalAdherence", "AgentHistoricalAdherenceConformance", "AgentSchedule", "AgentTimeOffRequest", "AgentWorkPlanBid", "AgentScheduleBid", "AlternativeShift", "Coaching", "Learning", "AgentUnavailableTimes", "AgentOpportunitiesQuery", "AgentOpportunitiesEnrollments", "AgentOpportunitiesEnrollmentsStatuses", "ActivityCodes", "ActivityPlans", "UnavailableTimes", "Agents", "BuActivityCodes", "BusinessUnits", "CapacityPlan", "ContinuousForecast", "HistoricalAdherence", "HistoricalShrinkage", "IntradayMonitoring", "BuIntradayMonitoring", "ManagementUnits", "RealTimeAdherence", "Schedules", "BuSchedules", "ServiceGoalTemplates", "PlanningGroups", "LongTermStaffing", "ShiftTrading", "ShortTermForecasts", "BuShortTermForecasts", "StaffingGroups", "TimeOffPlans", "TimeOffRequests", "TimeOffLimits", "WorkPlanBids", "WorkPlanBidGroups", "WorkPlanRotations", "WorkPlans", "ScheduleBid", "ScheduleBidGroup", "Opportunities", "OpportunitiesQuery", "OpportunitiesEnrollmentsQuery", "OpportunitiesExternalActivitiesQuery", "OpportunitiesStatuses", "OpportunitiesEnrollmentsStatuses" ] }, "divisionId": { "type": "string", "description": "If specified, the list of management units belonging to the specified division will be returned" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_notifications Get a list of notifications for the current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_team\_adherence Get a list of user schedule adherence records for the requested team **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------ | | `teamId` | string | Yes | — | The ID of the team | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "string", "description": "The ID of the team" } }, "required": [ "PCID", "teamId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_timeoffrequest Get a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------ | | `timeOffRequestId` | string | Yes | — | The ID of the time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request" } }, "required": [ "PCID", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_get\_workforcemanagement\_timeoffrequests Get a list of time off requests for the current user ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## genesys\_workforce\_patch\_agent\_adherence\_explanation Update an adherence explanation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | --------------------------------------- | | `agentId` | string | Yes | — | The ID of the agent to query | | `explanationId` | string | Yes | — | The ID of the explanation to update | | `status` | string | No | — | The status of the adherence explanation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The ID of the agent to query" }, "explanationId": { "type": "string", "description": "The ID of the explanation to update" }, "status": { "type": "string", "description": "The status of the adherence explanation", "enum": [ "Pending", "Approved", "Denied" ] } }, "required": [ "PCID", "agentId", "explanationId" ] } ``` *** ## genesys\_workforce\_patch\_managementunit Update the requested management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `divisionId` | string | No | — | The new division id for the management unit | | `name` | string | No | — | The new name of the management unit | | `settings` | object | No | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "divisionId": { "type": "string", "description": "The new division id for the management unit" }, "name": { "type": "string", "description": "The new name of the management unit" }, "settings": { "type": "object", "description": "The settings value", "properties": { "adherence": { "type": "object", "description": "The adherence value" }, "shortTermForecasting": { "type": "object", "description": "Short Term Forecasting" }, "timeOff": { "type": "object", "description": "Time Off" }, "scheduling": { "type": "object", "description": "The scheduling value" }, "shiftTrading": { "type": "object", "description": "Shift Trading" }, "metadata": { "type": "object", "description": "The metadata value" } }, "required": [ "metadata" ] } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_agents Update agent configurations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `entities` | object\[] | No | — | List of agents to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "entities": { "type": "array", "items": { "type": "object", "properties": { "schedulable": { "type": "boolean", "description": "Whether the agent can be included in schedule generation" }, "userId": { "type": "string", "description": "User to be updated" } }, "required": [ "userId" ] }, "description": "List of agents to update" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_timeofflimit Updates a time off limit object. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ----------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffLimitId` | string | Yes | — | The id of time off limit object to update | | `defaultLimitMinutes` | integer | No | — | The default time off limit value in minutes per granularity | | `metadata` | object | Yes | — | The metadata value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffLimitId": { "type": "string", "description": "The id of time off limit object to update" }, "defaultLimitMinutes": { "type": "integer", "description": "The default time off limit value in minutes per granularity" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] } }, "required": [ "PCID", "managementUnitId", "timeOffLimitId", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_timeoffplan Updates a time off plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `timeOffPlanId` | string | Yes | — | The ID of the time off plan to update | | `active` | boolean | No | — | Whether this time off plan should be used by agents. | | `activityCodeIds` | object | No | — | Activity Code Ids | | `autoApprovalRule` | string | No | — | Auto approval rule for the time off plan. | | `daysBeforeStartToExpireFromWaitlist` | integer | No | — | The number of days before the time off request start date for when the request will be expired from the waitlist. | | `hrisTimeOffType` | object | No | — | Hris Time Off Type | | `metadata` | object | Yes | — | The metadata value | | `name` | string | No | — | The name of this time off plan. | | `timeOffLimitIds` | object | No | — | Time Off Limit Ids | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "timeOffPlanId": { "type": "string", "description": "The ID of the time off plan to update" }, "active": { "type": "boolean", "description": "Whether this time off plan should be used by agents." }, "activityCodeIds": { "type": "object", "description": "Activity Code Ids", "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "The values value" } } }, "autoApprovalRule": { "type": "string", "description": "Auto approval rule for the time off plan.", "enum": [ "Never", "Always", "CheckLimits", "CheckActivityCodes", "CheckLimitsAndActivityCodes" ] }, "daysBeforeStartToExpireFromWaitlist": { "type": "integer", "description": "The number of days before the time off request start date for when the request will be expired from the waitlist." }, "hrisTimeOffType": { "type": "object", "description": "Hris Time Off Type", "properties": { "value": { "type": "object", "description": "The value value" } } }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] }, "name": { "type": "string", "description": "The name of this time off plan." }, "timeOffLimitIds": { "type": "object", "description": "Time Off Limit Ids", "properties": { "values": { "type": "array", "items": { "type": "string" }, "description": "The values value" } } } }, "required": [ "PCID", "managementUnitId", "timeOffPlanId", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_timeoffrequest\_user\_integrationstatus Set integration status for a time off request. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ----------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffRequestId` | string | Yes | — | The ID of the time off request. | | `userId` | string | Yes | — | The ID of user to whom the time off request belongs. | | `integrationStatus` | string | Yes | — | The integration status value for the time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request." }, "userId": { "type": "string", "description": "The ID of user to whom the time off request belongs." }, "integrationStatus": { "type": "string", "description": "The integration status value for the time off request", "enum": [ "Processing", "Error", "AutomaticallyComplete", "ManuallyComplete" ] } }, "required": [ "PCID", "managementUnitId", "timeOffRequestId", "userId", "integrationStatus" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_user\_timeoffrequest Update a time off request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `userId` | string | Yes | — | The id of the user the requested time off request belongs to | | `timeOffRequestId` | string | Yes | — | The id of the time off request to update | | `activityCodeId` | string | No | — | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | | `dailyDurationMinutes` | integer | No | — | The daily duration of this time off request in minutes | | `durationMinutes` | integer\[] | No | — | Daily durations for each day of this time off request in minutes | | `fullDayEarliestStartOffsetMinutes` | object | No | — | Full Day Earliest Start Offset Minutes | | `fullDayLatestEndOffsetMinutes` | object | No | — | Full Day Latest End Offset Minutes | | `fullDayManagementUnitDates` | string\[] | No | — | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone | | `metadata` | object | Yes | — | The metadata value | | `notes` | string | No | — | Notes about the time off request | | `paid` | boolean | No | — | Whether this is a paid time off request | | `partialDayStartDateTimes` | string\[] | No | — | A set of start date-times in ISO-8601 format for partial day requests | | `payableMinutes` | integer\[] | No | — | Payable minutes for each day of this time off request | | `status` | string | No | — | The status of this time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "userId": { "type": "string", "description": "The id of the user the requested time off request belongs to" }, "timeOffRequestId": { "type": "string", "description": "The id of the time off request to update" }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category" }, "dailyDurationMinutes": { "type": "integer", "description": "The daily duration of this time off request in minutes" }, "durationMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Daily durations for each day of this time off request in minutes" }, "fullDayEarliestStartOffsetMinutes": { "type": "object", "description": "Full Day Earliest Start Offset Minutes", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The values value" } } }, "fullDayLatestEndOffsetMinutes": { "type": "object", "description": "Full Day Latest End Offset Minutes", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The values value" } } }, "fullDayManagementUnitDates": { "type": "array", "items": { "type": "string" }, "description": "A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] }, "notes": { "type": "string", "description": "Notes about the time off request" }, "paid": { "type": "boolean", "description": "Whether this is a paid time off request" }, "partialDayStartDateTimes": { "type": "array", "items": { "type": "string", "format": "date-time" }, "description": "A set of start date-times in ISO-8601 format for partial day requests" }, "payableMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Payable minutes for each day of this time off request" }, "status": { "type": "string", "description": "The status of this time off request", "enum": [ "PENDING", "APPROVED", "DENIED" ] } }, "required": [ "PCID", "managementUnitId", "userId", "timeOffRequestId", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_week\_shifttrade Updates a shift trade. This route can only be called by the initiating agent **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `weekDateId` | string | Yes | — | The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `tradeId` | string | Yes | — | The ID of the shift trade to update | | `acceptableIntervals` | object | No | — | Acceptable Intervals | | `expiration` | object | No | — | The expiration value | | `metadata` | object | Yes | — | The metadata value | | `receivingUserId` | object | No | — | Receiving User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "weekDateId": { "type": "string", "description": "The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "tradeId": { "type": "string", "description": "The ID of the shift trade to update" }, "acceptableIntervals": { "type": "object", "description": "Acceptable Intervals", "properties": { "values": { "type": "array", "items": { "type": "string", "format": "interval" }, "description": "Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" } } }, "expiration": { "type": "object", "description": "The expiration value", "properties": { "value": { "type": "string", "description": "The value for the associated field. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } } }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" }, "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "version" ] }, "receivingUserId": { "type": "object", "description": "Receiving User Id", "properties": { "value": { "type": "string", "description": "The value for the associated field" } } } }, "required": [ "PCID", "managementUnitId", "weekDateId", "tradeId", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_workplan Update a work plan **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanId` | string | Yes | — | The ID of the work plan to update | | `validationMode` | string | No | — | Allows to update work plan even if validation result is invalid | | `agentCount` | integer | No | — | Number of agents in this work plan | | `agents` | object\[] | No | — | Agents in this work plan | | `constrainMaximumConsecutiveWorkingDays` | boolean | No | — | Whether to constrain the maximum consecutive working days | | `constrainMaximumConsecutiveWorkingWeekends` | boolean | No | — | Whether to constrain the maximum consecutive working weekends | | `constrainMaximumWorkingWeekendsPerPlanningPeriod` | boolean | No | — | Whether to constrain the maximum working weekends in the planning period | | `constrainMinimumTimeBetweenShifts` | boolean | No | — | Whether the minimum time between shifts constraint is enabled for this work plan | | `constrainPaidTimeGranularity` | boolean | No | — | Whether paid time granularity is constrained for this work plan | | `constrainWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is enabled for this work plan | | `enabled` | boolean | No | — | Whether the work plan is enabled for scheduling | | `flexibleWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is flexible for this work plan | | `id` | string | Yes | — | The globally unique identifier for the object. | | `maximumConsecutiveWorkingDays` | integer | No | — | The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true | | `maximumConsecutiveWorkingWeekends` | integer | No | — | The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work | | `maximumDays` | integer | No | — | Maximum number days in a week allowed to be scheduled for this work plan | | `maximumDaysOffPerPlanningPeriod` | integer | No | — | Maximum days off in the planning period | | `maximumPaidMinutesPerPlanningPeriod` | integer | No | — | Maximum paid minutes in the planning period | | `maximumWorkingWeekendsPerPlanningPeriod` | integer | No | — | Maximum working weekends in the planning period | | `metadata` | object | Yes | — | The metadata value | | `minimumConsecutiveNonWorkingMinutesPerWeek` | integer | No | — | Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off | | `minimumDaysOffPerPlanningPeriod` | integer | No | — | Minimum days off in the planning period | | `minimumPaidMinutesPerPlanningPeriod` | integer | No | — | Minimum paid minutes in the planning period | | `minimumShiftStartDistanceMinutes` | integer | No | — | The time period in minutes for the duration between the start times of two consecutive working days | | `minimumTimeBetweenShiftsMinutes` | integer | No | — | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | | `minimumWorkingDaysPerWeek` | integer | No | — | The minimum number of days that agents assigned to a work plan must work per week | | `name` | string | No | — | The name value | | `optionalDays` | object | No | — | Optional Days | | `paidTimeGranularityMinutes` | integer | No | — | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | | `selfUri` | string | No | — | The URI for this object | | `shifts` | object\[] | No | — | Shifts in this work plan | | `shiftStartVariancePeriod` | string | No | — | The length of the period over which the maximum shift start time variance is applied | | `shiftStartVariances` | object | No | — | Shift Start Variances | | `shiftStartVarianceType` | string | No | — | This constraint ensures that an agent starts each workday within a user-defined time threshold | | `valid` | boolean | No | — | Whether the work plan is valid or not | | `weeklyExactPaidMinutes` | integer | No | — | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | | `weeklyMaximumPaidMinutes` | integer | No | — | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | | `weeklyMinimumPaidMinutes` | integer | No | — | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanId": { "type": "string", "description": "The ID of the work plan to update" }, "validationMode": { "type": "string", "description": "Allows to update work plan even if validation result is invalid", "enum": [ "Ignore" ] }, "agentCount": { "type": "integer", "description": "Number of agents in this work plan" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "delete": { "type": "boolean", "description": "If marked true, the user will be removed an associated entity" }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } } }, "description": "Agents in this work plan" }, "constrainMaximumConsecutiveWorkingDays": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working days" }, "constrainMaximumConsecutiveWorkingWeekends": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working weekends" }, "constrainMaximumWorkingWeekendsPerPlanningPeriod": { "type": "boolean", "description": "Whether to constrain the maximum working weekends in the planning period" }, "constrainMinimumTimeBetweenShifts": { "type": "boolean", "description": "Whether the minimum time between shifts constraint is enabled for this work plan" }, "constrainPaidTimeGranularity": { "type": "boolean", "description": "Whether paid time granularity is constrained for this work plan" }, "constrainWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is enabled for this work plan" }, "enabled": { "type": "boolean", "description": "Whether the work plan is enabled for scheduling" }, "flexibleWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is flexible for this work plan" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "maximumConsecutiveWorkingDays": { "type": "integer", "description": "The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true" }, "maximumConsecutiveWorkingWeekends": { "type": "integer", "description": "The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work" }, "maximumDays": { "type": "integer", "description": "Maximum number days in a week allowed to be scheduled for this work plan" }, "maximumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Maximum days off in the planning period" }, "maximumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Maximum paid minutes in the planning period" }, "maximumWorkingWeekendsPerPlanningPeriod": { "type": "integer", "description": "Maximum working weekends in the planning period" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] }, "minimumConsecutiveNonWorkingMinutesPerWeek": { "type": "integer", "description": "Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off" }, "minimumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Minimum days off in the planning period" }, "minimumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Minimum paid minutes in the planning period" }, "minimumShiftStartDistanceMinutes": { "type": "integer", "description": "The time period in minutes for the duration between the start times of two consecutive working days" }, "minimumTimeBetweenShiftsMinutes": { "type": "integer", "description": "Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true" }, "minimumWorkingDaysPerWeek": { "type": "integer", "description": "The minimum number of days that agents assigned to a work plan must work per week" }, "name": { "type": "string", "description": "The name value" }, "optionalDays": { "type": "object", "description": "Optional Days", "properties": { "values": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "description": "The values value" } } }, "paidTimeGranularityMinutes": { "type": "integer", "description": "Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "shifts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the shift" }, "days": { "type": "object", "description": "The days value" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the shift is flexible" }, "exactStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false" }, "earliestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "constrainStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead" }, "constrainLatestStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled" }, "latestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true" }, "constrainEarliestStopTime": { "type": "boolean", "description": "Whether the earliest stop time constraint for the shift is enabled" }, "earliestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "This is the earliest time a shift can end" }, "startIncrementMinutes": { "type": "integer", "format": "int32", "description": "Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true" }, "flexiblePaidTime": { "type": "boolean", "description": "Whether the paid time setting for the shift is flexible" }, "exactPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false" }, "minimumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "maximumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "constrainContiguousWorkTime": { "type": "boolean", "description": "Whether the contiguous time constraint for the shift is enabled" }, "minimumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "maximumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "constrainDayOff": { "type": "boolean", "description": "Whether day off rule is enabled" }, "dayOffRule": { "type": "string", "enum": [ "NextDayOff", "PreviousDayOff" ], "description": "The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true" }, "planningPeriodConstraints": { "type": "object", "description": "Planning Period Constraints" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "activityCodeId": { "type": "string", "description": "ID of the activity code associated with this activity" }, "description": { "type": "string", "description": "Description of the activity" }, "lengthMinutes": { "type": "integer", "description": "Length of the activity in minutes" }, "startTimeIsRelativeToShiftStart": { "type": "boolean", "description": "Whether the start time of the activity is relative to the start time of the shift it belongs to" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the activity is flexible" }, "earliestStartTimeMinutes": { "type": "integer", "description": "Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutes": { "type": "integer", "description": "Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "exactStartTimeMinutes": { "type": "integer", "description": "Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false" }, "startTimeIncrementMinutes": { "type": "integer", "description": "Increment in offset minutes that would contribute to different possible start times for the activity" }, "countsAsPaidTime": { "type": "boolean", "description": "Whether the activity is paid" }, "countsAsContiguousWorkTime": { "type": "boolean", "description": "Whether the activity duration is counted towards contiguous work time" }, "minimumLengthFromShiftStartMinutes": { "type": "integer", "description": "The minimum duration between shift start and shift item (e.g., break or meal) start in minutes" }, "minimumLengthFromShiftEndMinutes": { "type": "integer", "description": "The minimum duration between shift item (e.g., break or meal) end and shift end in minutes" }, "maximumLengthFromShiftEndMinutes": { "type": "integer", "description": "The maximum duration between shift item (e.g., break or meal) end and shift end in minutes" }, "id": { "type": "string", "description": "ID of the activity. This is required only for the case of updating an existing activity" }, "delete": { "type": "boolean", "description": "If marked true for updating an existing activity, the activity will be permanently deleted" }, "validationId": { "type": "string", "description": "ID of the activity in the context of work plan validation" } } }, "description": "Activities configured for this shift" }, "id": { "type": "string", "description": "ID of the shift. This is required only for the case of updating an existing shift" }, "delete": { "type": "boolean", "description": "If marked true for updating an existing shift, the shift will be permanently deleted" }, "validationId": { "type": "string", "description": "ID of shift in the context of work plan validation" } }, "required": [ "name" ] }, "description": "Shifts in this work plan" }, "shiftStartVariancePeriod": { "type": "string", "description": "The length of the period over which the maximum shift start time variance is applied", "enum": [ "Weekly", "PlanningPeriod" ] }, "shiftStartVariances": { "type": "object", "description": "Shift Start Variances", "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "The values value" } } }, "shiftStartVarianceType": { "type": "string", "description": "This constraint ensures that an agent starts each workday within a user-defined time threshold", "enum": [ "ShiftStart", "ShiftStartAndPaidDuration" ] }, "valid": { "type": "boolean", "description": "Whether the work plan is valid or not" }, "weeklyExactPaidMinutes": { "type": "integer", "description": "Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false" }, "weeklyMaximumPaidMinutes": { "type": "integer", "description": "Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" }, "weeklyMinimumPaidMinutes": { "type": "integer", "description": "Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" } }, "required": [ "PCID", "managementUnitId", "workPlanId", "id", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_managementunit\_workplanrotation Update a work plan rotation **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanRotationId` | string | Yes | — | The ID of the work plan rotation to update | | `agents` | object\[] | No | — | Agents in this work plan rotation | | `dateRange` | object | No | — | Date Range | | `enabled` | boolean | No | — | Whether the work plan rotation is enabled for scheduling | | `metadata` | object | Yes | — | The metadata value | | `name` | string | No | — | Name of this work plan rotation | | `pattern` | object | No | — | The pattern value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanRotationId": { "type": "string", "description": "The ID of the work plan rotation to update" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "The ID of an agent in this work plan rotation" }, "dateRange": { "type": "object", "description": "Date Range" }, "position": { "type": "integer", "format": "int32", "description": "Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0" }, "delete": { "type": "boolean", "description": "If marked true for this agent when updating, then this agent will be removed from this work plan rotation" } }, "required": [ "userId" ] }, "description": "Agents in this work plan rotation" }, "dateRange": { "type": "object", "description": "Date Range", "properties": { "startBusinessUnitDate": { "type": "string", "description": "The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endBusinessUnitDate": { "type": "string", "description": "The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "startBusinessUnitDate" ] }, "enabled": { "type": "boolean", "description": "Whether the work plan rotation is enabled for scheduling" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] }, "name": { "type": "string", "description": "Name of this work plan rotation" }, "pattern": { "type": "object", "description": "The pattern value", "properties": { "workPlanIds": { "type": "array", "items": { "type": "string" }, "description": "List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty" } }, "required": [ "workPlanIds" ] } }, "required": [ "PCID", "managementUnitId", "workPlanRotationId", "metadata" ] } ``` *** ## genesys\_workforce\_patch\_timeoffrequest Update a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ | | `timeOffRequestId` | string | Yes | — | The ID of the time off request | | `fullDayEarliestStartOffsetMinutes` | object | No | — | Full Day Earliest Start Offset Minutes | | `fullDayLatestEndOffsetMinutes` | object | No | — | Full Day Latest End Offset Minutes | | `markedAsRead` | boolean | No | — | Whether this request has been read by the agent | | `notes` | string | No | — | Notes about the time off request. Can only be edited while the request is still pending | | `status` | string | No | — | The status of this time off request. Can only be canceled if the requested date has not already passed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeOffRequestId": { "type": "string", "description": "The ID of the time off request" }, "fullDayEarliestStartOffsetMinutes": { "type": "object", "description": "Full Day Earliest Start Offset Minutes", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The values value" } } }, "fullDayLatestEndOffsetMinutes": { "type": "object", "description": "Full Day Latest End Offset Minutes", "properties": { "values": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The values value" } } }, "markedAsRead": { "type": "boolean", "description": "Whether this request has been read by the agent" }, "notes": { "type": "string", "description": "Notes about the time off request. Can only be edited while the request is still pending" }, "status": { "type": "string", "description": "The status of this time off request. Can only be canceled if the requested date has not already passed", "enum": [ "CANCELED" ] } }, "required": [ "PCID", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_post\_adherence\_explanations Submit an adherence explanation for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------------------------------------- | | `lengthMinutes` | integer | Yes | — | The length of the adherence explanation in minutes | | `notes` | string | No | — | Notes about the adherence explanation | | `startDate` | string | Yes | — | The start timestamp of the adherence explanation in ISO-8601 format | | `type` | string | Yes | — | The type of the adherence explanation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "lengthMinutes": { "type": "integer", "description": "The length of the adherence explanation in minutes" }, "notes": { "type": "string", "description": "Notes about the adherence explanation" }, "startDate": { "type": "string", "description": "The start timestamp of the adherence explanation in ISO-8601 format" }, "type": { "type": "string", "description": "The type of the adherence explanation", "enum": [ "Late" ] } }, "required": [ "PCID", "lengthMinutes", "startDate", "type" ] } ``` *** ## genesys\_workforce\_post\_adherence\_explanations\_query Query adherence explanations for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `forceAsync` | boolean | No | — | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `endDate` | string | Yes | — | The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forceAsync": { "type": "boolean", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "endDate": { "type": "string", "description": "The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "PCID", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_agent\_adherence\_explanations Add an adherence explanation for the requested user **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------------------------------------------------- | | `agentId` | string | Yes | — | The ID of the agent to query | | `lengthMinutes` | integer | Yes | — | The length of the adherence explanation in minutes | | `notes` | string | No | — | Notes about the adherence explanation | | `startDate` | string | Yes | — | The start timestamp of the adherence explanation in ISO-8601 format | | `status` | string | No | — | The status of the adherence explanation | | `type` | string | Yes | — | The type of the adherence explanation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The ID of the agent to query" }, "lengthMinutes": { "type": "integer", "description": "The length of the adherence explanation in minutes" }, "notes": { "type": "string", "description": "Notes about the adherence explanation" }, "startDate": { "type": "string", "description": "The start timestamp of the adherence explanation in ISO-8601 format" }, "status": { "type": "string", "description": "The status of the adherence explanation", "enum": [ "Pending", "Approved", "Denied" ] }, "type": { "type": "string", "description": "The type of the adherence explanation", "enum": [ "Late" ] } }, "required": [ "PCID", "agentId", "lengthMinutes", "startDate", "type" ] } ``` *** ## genesys\_workforce\_post\_agent\_adherence\_explanations\_query Query adherence explanations for the given agent across a specified range **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | | `agentId` | string | Yes | — | The ID of the agent to query | | `forceAsync` | boolean | No | — | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `endDate` | string | Yes | — | The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "agentId": { "type": "string", "description": "The ID of the agent to query" }, "forceAsync": { "type": "boolean", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "endDate": { "type": "string", "description": "The end date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "The start date of the range to query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "PCID", "agentId", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_agents Move agents in and out of management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `destinationManagementUnitId` | string | No | — | The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null. | | `userIds` | string\[] | Yes | — | The list of user ids to move | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "destinationManagementUnitId": { "type": "string", "description": "The id of the management unit for which the move will be performed. To remove users from their management unit this should be set to null." }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The list of user ids to move" } }, "required": [ "PCID", "userIds" ] } ``` *** ## genesys\_workforce\_post\_agents\_me\_adherence\_historical\_jobs Request an agent historical adherence report **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `expand` | string\[] | No | — | Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities. | | `endDate` | string | No | — | End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time | | `startDate` | string | Yes | — | Beginning of the date range to query in ISO-8601 format | | `timeZone` | string | No | — | The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "exceptionInfo", "actuals", "scheduledActivities", "conformance" ] }, "description": "Which fields, if any, to expand with. wfm:AgentHistoricalAdherenceConformance:view permission is required for conformance, and wfm:agentSchedule:view permission is required for scheduledActivities." }, "endDate": { "type": "string", "description": "End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time" }, "startDate": { "type": "string", "description": "Beginning of the date range to query in ISO-8601 format" }, "timeZone": { "type": "string", "description": "The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input." } }, "required": [ "PCID", "startDate" ] } ``` *** ## genesys\_workforce\_post\_agents\_me\_possibleworkshifts Get agent possible work shifts for requested time frame **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `weekCount` | integer | Yes | — | Number of weeks for which to return possible work shifts | | `weekStartDate` | string | Yes | — | Start date of requested effective work plan, day of week will be in line with business unit start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "weekCount": { "type": "integer", "description": "Number of weeks for which to return possible work shifts" }, "weekStartDate": { "type": "string", "description": "Start date of requested effective work plan, day of week will be in line with business unit start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "PCID", "weekCount", "weekStartDate" ] } ``` *** ## genesys\_workforce\_post\_agentschedules\_managementunits\_mine Fetch agent schedules for the logged in user's management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `forceAsync` | boolean | No | — | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `endDate` | string | Yes | — | The end date for the range to query the schedule's for the agent's management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | The start date for the range to query the schedule's for the agent's management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "forceAsync": { "type": "boolean", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "endDate": { "type": "string", "description": "The end date for the range to query the schedule's for the agent's management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "The start date for the range to query the schedule's for the agent's management unit. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "PCID", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_agentschedules\_mine Get published schedule for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `endDate` | string | Yes | — | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "endDate": { "type": "string", "description": "End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "PCID", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_agents\_workplans\_query Get agents work plans configuration **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `agentIds` | string\[] | Yes | — | The list of agent IDs | | `startDate` | string | Yes | — | The start of a date in yyyy-MM-dd format. Response contains values rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `weekCount` | integer | Yes | — | The number of weeks to query | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "agentIds": { "type": "array", "items": { "type": "string" }, "description": "The list of agent IDs" }, "startDate": { "type": "string", "description": "The start of a date in yyyy-MM-dd format. Response contains values rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "weekCount": { "type": "integer", "description": "The number of weeks to query" } }, "required": [ "PCID", "managementUnitId", "agentIds", "startDate", "weekCount" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_agentschedules\_search Query published schedules for given given time range for set of users **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `forceAsync` | boolean | No | — | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `endDate` | string | Yes | — | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `userIds` | string\[] | No | — | IDs of the users for whose schedules to search | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "forceAsync": { "type": "boolean", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "endDate": { "type": "string", "description": "End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "IDs of the users for whose schedules to search" } }, "required": [ "PCID", "managementUnitId", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_historicaladherencequery Request a historical adherence report **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `endDate` | string | No | — | End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time | | `includeExceptions` | boolean | No | — | Whether user exceptions should be returned as part of the results | | `startDate` | string | Yes | — | Beginning of the date range to query in ISO-8601 format | | `teamIds` | string\[] | No | — | The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned | | `timeZone` | string | No | — | The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. | | `userIds` | string\[] | No | — | The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "endDate": { "type": "string", "description": "End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time" }, "includeExceptions": { "type": "boolean", "description": "Whether user exceptions should be returned as part of the results" }, "startDate": { "type": "string", "description": "Beginning of the date range to query in ISO-8601 format" }, "teamIds": { "type": "array", "items": { "type": "string" }, "description": "The teamIds to report on. If null or not set, adherence will be computed for requested users if applicable or otherwise all users in the management unit. Note: If teamIds is also specified, only adherence for users in the requested teams will be returned" }, "timeZone": { "type": "string", "description": "The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input." }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds" } }, "required": [ "PCID", "managementUnitId", "startDate" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_move Move the requested management unit to a new business unit **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `businessUnitId` | string | Yes | — | The ID of the business unit to which to move the management unit | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "businessUnitId": { "type": "string", "description": "The ID of the business unit to which to move the management unit" } }, "required": [ "PCID", "managementUnitId", "businessUnitId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeofflimits Creates a new time off limit object under management unit. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `defaultLimitMinutes` | integer | No | — | The default limit value in minutes per granularity. If not specified, then 0 is assumed, which means there are no time off minutes available | | `granularity` | string | No | — | Granularity choice for time off limit. If not specified, 'Daily' is assumed | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "defaultLimitMinutes": { "type": "integer", "description": "The default limit value in minutes per granularity. If not specified, then 0 is assumed, which means there are no time off minutes available" }, "granularity": { "type": "string", "description": "Granularity choice for time off limit. If not specified, 'Daily' is assumed", "enum": [ "Daily", "FifteenMinutes" ] } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeofflimits\_values\_query Retrieves time off limit related values based on a given set of filters. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `activityCodeId` | string | No | — | The ID of the activity code by which to filter the affected limit objects. Required if timeOffLimitId is not specified | | `dateRanges` | object\[] | Yes | — | The list of the date ranges to return time off limit, allocated and waitlisted minutes. The valid number of date ranges is between 1 and 30. Maximum total number of days in all ranges in 366. | | `timeOffLimitId` | string | No | — | The time off limit object id to retrieve values for. Required if activityCodeId is not specified | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "activityCodeId": { "type": "string", "description": "The ID of the activity code by which to filter the affected limit objects. Required if timeOffLimitId is not specified" }, "dateRanges": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endDate": { "type": "string", "format": "date", "description": "The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } } }, "description": "The list of the date ranges to return time off limit, allocated and waitlisted minutes. The valid number of date ranges is between 1 and 30. Maximum total number of days in all ranges in 366." }, "timeOffLimitId": { "type": "string", "description": "The time off limit object id to retrieve values for. Required if activityCodeId is not specified" } }, "required": [ "PCID", "managementUnitId", "dateRanges" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeoffplans Creates a new time off plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `active` | boolean | Yes | — | Whether this time off plan should be used by agents. | | `activityCodeIds` | string\[] | No | — | The set of activity code IDs to associate with this time off plan. | | `autoApprovalRule` | string | Yes | — | Auto approval rule for the time off plan. | | `daysBeforeStartToExpireFromWaitlist` | integer | No | — | The number of days before the time off request start date for when the request will be expired from the waitlist. | | `hrisTimeOffType` | object | No | — | Hris Time Off Type | | `name` | string | Yes | — | The name of this time off plan. | | `timeOffLimitIds` | string\[] | No | — | The set of time off limit IDs to associate with this time off plan. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "active": { "type": "boolean", "description": "Whether this time off plan should be used by agents." }, "activityCodeIds": { "type": "array", "items": { "type": "string" }, "description": "The set of activity code IDs to associate with this time off plan." }, "autoApprovalRule": { "type": "string", "description": "Auto approval rule for the time off plan.", "enum": [ "Never", "Always", "CheckLimits", "CheckActivityCodes", "CheckLimitsAndActivityCodes" ] }, "daysBeforeStartToExpireFromWaitlist": { "type": "integer", "description": "The number of days before the time off request start date for when the request will be expired from the waitlist." }, "hrisTimeOffType": { "type": "object", "description": "Hris Time Off Type", "properties": { "id": { "type": "string", "description": "The ID of the time off type configured in integration." }, "name": { "type": "string", "description": "The name of the time off type configured in integration." }, "hrisIntegrationId": { "type": "string", "description": "The ID of the integration." }, "secondaryId": { "type": "string", "description": "Secondary ID of the time off type, if configured in integration." } }, "required": [ "hrisIntegrationId", "id", "name" ] }, "name": { "type": "string", "description": "The name of this time off plan." }, "timeOffLimitIds": { "type": "array", "items": { "type": "string" }, "description": "The set of time off limit IDs to associate with this time off plan." } }, "required": [ "PCID", "managementUnitId", "active", "autoApprovalRule", "name" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeoffrequests Create a new time off request **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `activityCodeId` | string | Yes | — | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | | `dailyDurationMinutes` | integer | No | — | Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required | | `durationMinutes` | integer\[] | No | — | Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required | | `fullDayEarliestStartOffsetMinutes` | integer\[] | No | — | Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available | | `fullDayLatestEndOffsetMinutes` | integer\[] | No | — | Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available | | `fullDayManagementUnitDates` | string\[] | No | — | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone | | `notes` | string | No | — | Notes about the time off request | | `paid` | boolean | No | — | Whether this is a paid time off request. Defaults to the activity code's paid value if not specified | | `partialDayStartDateTimes` | string\[] | No | — | A set of start date-times in ISO-8601 format for partial day requests | | `payableMinutes` | integer\[] | No | — | Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified | | `status` | string | Yes | — | The status of this time off request | | `users` | object\[] | Yes | — | A set of IDs for users to associate with this time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category" }, "dailyDurationMinutes": { "type": "integer", "description": "Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required" }, "durationMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required" }, "fullDayEarliestStartOffsetMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available" }, "fullDayLatestEndOffsetMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available" }, "fullDayManagementUnitDates": { "type": "array", "items": { "type": "string" }, "description": "A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone" }, "notes": { "type": "string", "description": "Notes about the time off request" }, "paid": { "type": "boolean", "description": "Whether this is a paid time off request. Defaults to the activity code's paid value if not specified" }, "partialDayStartDateTimes": { "type": "array", "items": { "type": "string", "format": "date-time" }, "description": "A set of start date-times in ISO-8601 format for partial day requests" }, "payableMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified" }, "status": { "type": "string", "description": "The status of this time off request", "enum": [ "PENDING", "APPROVED" ] }, "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } } }, "description": "A set of IDs for users to associate with this time off request" } }, "required": [ "PCID", "managementUnitId", "activityCodeId", "status", "users" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeoffrequests\_integrationstatus\_query Retrieves integration statuses for a list of time off requests **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | --------- | -------- | ------- | ---------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffRequestLookups` | object\[] | Yes | — | A list of time off request lookups | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffRequestLookups": { "type": "array", "items": { "type": "object", "properties": { "timeOffRequestId": { "type": "string", "description": "The ID of the time off request" }, "userId": { "type": "string", "description": "The ID of the user to whom the time off request belongs" } }, "required": [ "timeOffRequestId", "userId" ] }, "description": "A list of time off request lookups" } }, "required": [ "PCID", "managementUnitId", "timeOffRequestLookups" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeoffrequests\_query Fetches time off requests matching the conditions specified in the request body **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `dateRange` | object | No | — | Date Range | | `ids` | string\[] | No | — | The set of ids to filter time off requests | | `statuses` | string\[] | No | — | The set of statuses to filter time off requests | | `substatuses` | string\[] | No | — | The set of substatuses to filter time off requests | | `userIds` | string\[] | No | — | The set of user ids to filter time off requests | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "dateRange": { "type": "object", "description": "Date Range", "properties": { "startDate": { "type": "string", "description": "The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone." }, "endDate": { "type": "string", "description": "The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone." } } }, "ids": { "type": "array", "items": { "type": "string" }, "description": "The set of ids to filter time off requests" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "PENDING", "APPROVED", "DENIED", "CANCELED" ] }, "description": "The set of statuses to filter time off requests" }, "substatuses": { "type": "array", "items": { "type": "string", "enum": [ "AdvanceTimeElapsed", "AutoApproved", "BlockedDate", "InsufficientBalance", "InvalidDailyDuration", "ManualApproval", "OutsideShift", "OverlapsRestrictedActivityCode", "RemovedFromWaitlist", "ReviewDate", "Waitlisted" ] }, "description": "The set of substatuses to filter time off requests" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The set of user ids to filter time off requests" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_timeoffrequests\_waitlistpositions\_query Retrieves daily waitlist position for a list of time off requests **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffRequests` | object\[] | Yes | — | The list of the time off request ids for which to fetch the daily waitlist positions | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffRequests": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the time off request" }, "user": { "type": "object", "description": "The user value" }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } }, "required": [ "user" ] }, "description": "The list of the time off request ids for which to fetch the daily waitlist positions" } }, "required": [ "PCID", "managementUnitId", "timeOffRequests" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_user\_timeoffbalance\_jobs Query time off balances for a given user for specified activity code and dates **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `userId` | string | Yes | — | The ID of the user | | `activityCodeIds` | string\[] | Yes | — | The set of activity code IDs for which to query available time off balances | | `dateRanges` | object\[] | No | — | The list of date ranges for which to query time off balance | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "userId": { "type": "string", "description": "The ID of the user" }, "activityCodeIds": { "type": "array", "items": { "type": "string" }, "description": "The set of activity code IDs for which to query available time off balances" }, "dateRanges": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endDate": { "type": "string", "format": "date", "description": "The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } } }, "description": "The list of date ranges for which to query time off balance" } }, "required": [ "PCID", "managementUnitId", "userId", "activityCodeIds" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_user\_timeoffrequest\_timeoffbalance\_jobs Query time off balances for dates spanned by a given time off request **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ------------------------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `userId` | string | Yes | — | The userId to whom the time off request applies. | | `timeOffRequestId` | string | Yes | — | The time off request id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "userId": { "type": "string", "description": "The userId to whom the time off request applies." }, "timeOffRequestId": { "type": "string", "description": "The time off request id." } }, "required": [ "PCID", "managementUnitId", "userId", "timeOffRequestId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_user\_timeoffrequests\_estimate Estimates available time off for an agent **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit | | `userId` | string | Yes | — | The id of the user for whom the time off request estimate is requested | | `includeOnly` | string | No | — | Limit response to the specified field | | `activityCodeId` | string | Yes | — | The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category | | `fullDayDates` | object\[] | No | — | Full day dates. partialDayDates must be empty if this field is populated | | `paid` | boolean | Yes | — | Whether this estimate is for a paid time off request | | `partialDayDates` | object\[] | No | — | Partial day dates. fullDayDates must be empty if this field is populated | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit" }, "userId": { "type": "string", "description": "The id of the user for whom the time off request estimate is requested" }, "includeOnly": { "type": "string", "description": "Limit response to the specified field", "enum": [ "overrideDateType" ] }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category" }, "fullDayDates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "requestedDurationMinutes": { "type": "integer", "format": "int32", "description": "A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting" } }, "required": [ "date" ] }, "description": "Full day dates. partialDayDates must be empty if this field is populated" }, "paid": { "type": "boolean", "description": "Whether this estimate is for a paid time off request" }, "partialDayDates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Start date-time in ISO-8601 format for partial day request" }, "requestedDurationMinutes": { "type": "integer", "format": "int32", "description": "A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting" } }, "required": [ "date" ] }, "description": "Partial day dates. fullDayDates must be empty if this field is populated" } }, "required": [ "PCID", "managementUnitId", "userId", "activityCodeId", "paid" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_week\_shifttrade\_match Matches a shift trade. This route can only be called by the receiving agent **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `weekDateId` | string | Yes | — | The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `tradeId` | string | Yes | — | The ID of the shift trade to update | | `metadata` | object | Yes | — | The metadata value | | `receivingScheduleId` | string | Yes | — | The ID of the schedule with which the shift trade is associated | | `receivingShiftId` | string | No | — | The ID of the shift the receiving user is giving up in trade, if applicable | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "weekDateId": { "type": "string", "description": "The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "tradeId": { "type": "string", "description": "The ID of the shift trade to update" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" }, "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "version" ] }, "receivingScheduleId": { "type": "string", "description": "The ID of the schedule with which the shift trade is associated" }, "receivingShiftId": { "type": "string", "description": "The ID of the shift the receiving user is giving up in trade, if applicable" } }, "required": [ "PCID", "managementUnitId", "weekDateId", "tradeId", "metadata", "receivingScheduleId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_week\_shifttrades Adds a shift trade **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `weekDateId` | string | Yes | — | The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `acceptableIntervals` | string\[] | No | — | The acceptable intervals the initiating user is willing to accept in trade. Empty indicates the user is giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | | `expiration` | string | No | — | When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `initiatingShiftId` | string | Yes | — | The ID of the shift that the initiating user wants to give up | | `receivingUserId` | string | No | — | The ID of the user to whom to send the request (for use in direct trade requests) | | `scheduleId` | string | Yes | — | The ID of the schedule to which the initiating and receiving shifts belong | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "weekDateId": { "type": "string", "description": "The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "acceptableIntervals": { "type": "array", "items": { "type": "string", "format": "interval" }, "description": "The acceptable intervals the initiating user is willing to accept in trade. Empty indicates the user is giving up the shift. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" }, "expiration": { "type": "string", "description": "When this shift trade request should expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "initiatingShiftId": { "type": "string", "description": "The ID of the shift that the initiating user wants to give up" }, "receivingUserId": { "type": "string", "description": "The ID of the user to whom to send the request (for use in direct trade requests)" }, "scheduleId": { "type": "string", "description": "The ID of the schedule to which the initiating and receiving shifts belong" } }, "required": [ "PCID", "managementUnitId", "weekDateId", "initiatingShiftId", "scheduleId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_week\_shifttrades\_search Searches for potential shift trade matches for the current agent **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `weekDateId` | string | Yes | — | The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `receivingScheduleId` | string | Yes | — | The ID of the schedule for which to search for available shift trades | | `receivingShiftIds` | string\[] | No | — | The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "weekDateId": { "type": "string", "description": "The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "receivingScheduleId": { "type": "string", "description": "The ID of the schedule for which to search for available shift trades" }, "receivingShiftIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of shifts that the receiving user would potentially be willing to trade. If empty, only returns one sided trades (pick up a shift)" } }, "required": [ "PCID", "managementUnitId", "weekDateId", "receivingScheduleId" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_workplan\_copy Create a copy of work plan **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanId` | string | Yes | — | The ID of the work plan to create a copy | | `name` | string | Yes | — | Name of the copied work plan | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanId": { "type": "string", "description": "The ID of the work plan to create a copy" }, "name": { "type": "string", "description": "Name of the copied work plan" } }, "required": [ "PCID", "managementUnitId", "workPlanId", "name" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_workplan\_validate Validate Work Plan **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanId` | string | Yes | — | The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. | | `expand` | string\[] | No | — | Related resources to expand inline | | `agentCount` | integer | No | — | Number of agents in this work plan | | `agents` | object\[] | No | — | Agents in this work plan | | `constrainMaximumConsecutiveWorkingDays` | boolean | No | — | Whether to constrain the maximum consecutive working days | | `constrainMaximumConsecutiveWorkingWeekends` | boolean | No | — | Whether to constrain the maximum consecutive working weekends | | `constrainMaximumWorkingWeekendsPerPlanningPeriod` | boolean | No | — | Whether to constrain the maximum working weekends in the planning period | | `constrainMinimumTimeBetweenShifts` | boolean | No | — | Whether the minimum time between shifts constraint is enabled for this work plan | | `constrainPaidTimeGranularity` | boolean | No | — | Whether paid time granularity is constrained for this work plan | | `constrainWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is enabled for this work plan | | `enabled` | boolean | No | — | Whether the work plan is enabled for scheduling | | `flexibleWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is flexible for this work plan | | `id` | string | Yes | — | The globally unique identifier for the object. | | `maximumConsecutiveWorkingDays` | integer | No | — | The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true | | `maximumConsecutiveWorkingWeekends` | integer | No | — | The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work | | `maximumDays` | integer | No | — | Maximum number days in a week allowed to be scheduled for this work plan | | `maximumDaysOffPerPlanningPeriod` | integer | No | — | Maximum days off in the planning period | | `maximumPaidMinutesPerPlanningPeriod` | integer | No | — | Maximum paid minutes in the planning period | | `maximumWorkingWeekendsPerPlanningPeriod` | integer | No | — | Maximum working weekends in the planning period | | `minimumConsecutiveNonWorkingMinutesPerWeek` | integer | No | — | Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off | | `minimumDaysOffPerPlanningPeriod` | integer | No | — | Minimum days off in the planning period | | `minimumPaidMinutesPerPlanningPeriod` | integer | No | — | Minimum paid minutes in the planning period | | `minimumShiftStartDistanceMinutes` | integer | No | — | The time period in minutes for the duration between the start times of two consecutive working days | | `minimumTimeBetweenShiftsMinutes` | integer | No | — | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | | `minimumWorkingDaysPerWeek` | integer | No | — | The minimum number of days that agents assigned to a work plan must work per week | | `name` | string | No | — | The name value | | `optionalDays` | object | No | — | Optional Days | | `paidTimeGranularityMinutes` | integer | No | — | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | | `selfUri` | string | No | — | The URI for this object | | `shifts` | object\[] | No | — | Shifts in this work plan | | `shiftStartVariancePeriod` | string | No | — | The length of the period over which the maximum shift start time variance is applied | | `shiftStartVariances` | object | No | — | Shift Start Variances | | `shiftStartVarianceType` | string | No | — | This constraint ensures that an agent starts each workday within a user-defined time threshold | | `valid` | boolean | No | — | Whether the work plan is valid or not | | `weeklyExactPaidMinutes` | integer | No | — | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | | `weeklyMaximumPaidMinutes` | integer | No | — | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | | `weeklyMinimumPaidMinutes` | integer | No | — | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanId": { "type": "string", "description": "The ID of the work plan to validate. For new work plan, use the word 'new' for the ID." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "messages" ] }, "description": "Related resources to expand inline" }, "agentCount": { "type": "integer", "description": "Number of agents in this work plan" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "delete": { "type": "boolean", "description": "If marked true, the user will be removed an associated entity" }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } } }, "description": "Agents in this work plan" }, "constrainMaximumConsecutiveWorkingDays": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working days" }, "constrainMaximumConsecutiveWorkingWeekends": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working weekends" }, "constrainMaximumWorkingWeekendsPerPlanningPeriod": { "type": "boolean", "description": "Whether to constrain the maximum working weekends in the planning period" }, "constrainMinimumTimeBetweenShifts": { "type": "boolean", "description": "Whether the minimum time between shifts constraint is enabled for this work plan" }, "constrainPaidTimeGranularity": { "type": "boolean", "description": "Whether paid time granularity is constrained for this work plan" }, "constrainWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is enabled for this work plan" }, "enabled": { "type": "boolean", "description": "Whether the work plan is enabled for scheduling" }, "flexibleWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is flexible for this work plan" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "maximumConsecutiveWorkingDays": { "type": "integer", "description": "The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true" }, "maximumConsecutiveWorkingWeekends": { "type": "integer", "description": "The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work" }, "maximumDays": { "type": "integer", "description": "Maximum number days in a week allowed to be scheduled for this work plan" }, "maximumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Maximum days off in the planning period" }, "maximumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Maximum paid minutes in the planning period" }, "maximumWorkingWeekendsPerPlanningPeriod": { "type": "integer", "description": "Maximum working weekends in the planning period" }, "minimumConsecutiveNonWorkingMinutesPerWeek": { "type": "integer", "description": "Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off" }, "minimumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Minimum days off in the planning period" }, "minimumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Minimum paid minutes in the planning period" }, "minimumShiftStartDistanceMinutes": { "type": "integer", "description": "The time period in minutes for the duration between the start times of two consecutive working days" }, "minimumTimeBetweenShiftsMinutes": { "type": "integer", "description": "Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true" }, "minimumWorkingDaysPerWeek": { "type": "integer", "description": "The minimum number of days that agents assigned to a work plan must work per week" }, "name": { "type": "string", "description": "The name value" }, "optionalDays": { "type": "object", "description": "Optional Days", "properties": { "values": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "description": "The values value" } } }, "paidTimeGranularityMinutes": { "type": "integer", "description": "Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true" }, "selfUri": { "type": "string", "description": "The URI for this object" }, "shifts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the shift" }, "days": { "type": "object", "description": "The days value" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the shift is flexible" }, "exactStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false" }, "earliestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "constrainStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead" }, "constrainLatestStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled" }, "latestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true" }, "constrainEarliestStopTime": { "type": "boolean", "description": "Whether the earliest stop time constraint for the shift is enabled" }, "earliestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "This is the earliest time a shift can end" }, "startIncrementMinutes": { "type": "integer", "format": "int32", "description": "Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true" }, "flexiblePaidTime": { "type": "boolean", "description": "Whether the paid time setting for the shift is flexible" }, "exactPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false" }, "minimumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "maximumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "constrainContiguousWorkTime": { "type": "boolean", "description": "Whether the contiguous time constraint for the shift is enabled" }, "minimumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "maximumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "constrainDayOff": { "type": "boolean", "description": "Whether day off rule is enabled" }, "dayOffRule": { "type": "string", "enum": [ "NextDayOff", "PreviousDayOff" ], "description": "The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true" }, "planningPeriodConstraints": { "type": "object", "description": "Planning Period Constraints" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "activityCodeId": { "type": "string", "description": "ID of the activity code associated with this activity" }, "description": { "type": "string", "description": "Description of the activity" }, "lengthMinutes": { "type": "integer", "description": "Length of the activity in minutes" }, "startTimeIsRelativeToShiftStart": { "type": "boolean", "description": "Whether the start time of the activity is relative to the start time of the shift it belongs to" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the activity is flexible" }, "earliestStartTimeMinutes": { "type": "integer", "description": "Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutes": { "type": "integer", "description": "Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "exactStartTimeMinutes": { "type": "integer", "description": "Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false" }, "startTimeIncrementMinutes": { "type": "integer", "description": "Increment in offset minutes that would contribute to different possible start times for the activity" }, "countsAsPaidTime": { "type": "boolean", "description": "Whether the activity is paid" }, "countsAsContiguousWorkTime": { "type": "boolean", "description": "Whether the activity duration is counted towards contiguous work time" }, "minimumLengthFromShiftStartMinutes": { "type": "integer", "description": "The minimum duration between shift start and shift item (e.g., break or meal) start in minutes" }, "minimumLengthFromShiftEndMinutes": { "type": "integer", "description": "The minimum duration between shift item (e.g., break or meal) end and shift end in minutes" }, "maximumLengthFromShiftEndMinutes": { "type": "integer", "description": "The maximum duration between shift item (e.g., break or meal) end and shift end in minutes" }, "id": { "type": "string", "description": "ID of the activity. This is required only for the case of updating an existing activity" }, "delete": { "type": "boolean", "description": "If marked true for updating an existing activity, the activity will be permanently deleted" }, "validationId": { "type": "string", "description": "ID of the activity in the context of work plan validation" } } }, "description": "Activities configured for this shift" }, "id": { "type": "string", "description": "ID of the shift. This is required only for the case of updating an existing shift" }, "delete": { "type": "boolean", "description": "If marked true for updating an existing shift, the shift will be permanently deleted" }, "validationId": { "type": "string", "description": "ID of shift in the context of work plan validation" } }, "required": [ "name" ] }, "description": "Shifts in this work plan" }, "shiftStartVariancePeriod": { "type": "string", "description": "The length of the period over which the maximum shift start time variance is applied", "enum": [ "Weekly", "PlanningPeriod" ] }, "shiftStartVariances": { "type": "object", "description": "Shift Start Variances", "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "The values value" } } }, "shiftStartVarianceType": { "type": "string", "description": "This constraint ensures that an agent starts each workday within a user-defined time threshold", "enum": [ "ShiftStart", "ShiftStartAndPaidDuration" ] }, "valid": { "type": "boolean", "description": "Whether the work plan is valid or not" }, "weeklyExactPaidMinutes": { "type": "integer", "description": "Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false" }, "weeklyMaximumPaidMinutes": { "type": "integer", "description": "Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" }, "weeklyMinimumPaidMinutes": { "type": "integer", "description": "Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" } }, "required": [ "PCID", "managementUnitId", "workPlanId", "id" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_workplanrotation\_copy Create a copy of work plan rotation **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `workPlanRotationId` | string | Yes | — | The ID of the work plan rotation to create a copy | | `name` | string | Yes | — | Name to apply to the new copy of the work plan rotation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "workPlanRotationId": { "type": "string", "description": "The ID of the work plan rotation to create a copy" }, "name": { "type": "string", "description": "Name to apply to the new copy of the work plan rotation" } }, "required": [ "PCID", "managementUnitId", "workPlanRotationId", "name" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_workplanrotations Create a new work plan rotation **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | --------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `agents` | object\[] | No | — | Agents in this work plan rotation | | `dateRange` | object | Yes | — | Date Range | | `name` | string | Yes | — | Name of this work plan rotation | | `pattern` | object | Yes | — | The pattern value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "agents": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string", "description": "The ID of an agent in this work plan rotation" }, "dateRange": { "type": "object", "description": "Date Range" }, "position": { "type": "integer", "format": "int32", "description": "Start position of the work plan in the pattern for this agent in the work plan rotation. Position value starts from 0" } }, "required": [ "dateRange", "position", "userId" ] }, "description": "Agents in this work plan rotation" }, "dateRange": { "type": "object", "description": "Date Range", "properties": { "startBusinessUnitDate": { "type": "string", "description": "The start date for work plan rotation or an agent, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endBusinessUnitDate": { "type": "string", "description": "The end date for work plan rotation or an agent, interpreted in the business unit's time zone. Null denotes open ended date range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "startBusinessUnitDate" ] }, "name": { "type": "string", "description": "Name of this work plan rotation" }, "pattern": { "type": "object", "description": "The pattern value", "properties": { "workPlanIds": { "type": "array", "items": { "type": "string" }, "description": "List of work plan IDs in order of rotation on a weekly basis. Values in the list cannot be null or empty" } }, "required": [ "workPlanIds" ] } }, "required": [ "PCID", "managementUnitId", "dateRange", "name", "pattern" ] } ``` *** ## genesys\_workforce\_post\_managementunit\_workplans Create a new work plan **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `validationMode` | string | No | — | Allows to create work plan even if the validation result is invalid | | `agents` | object\[] | No | — | Agents in this work plan | | `constrainMaximumConsecutiveWorkingDays` | boolean | No | — | Whether to constrain the maximum consecutive working days | | `constrainMaximumConsecutiveWorkingWeekends` | boolean | No | — | Whether to constrain the maximum consecutive working weekends | | `constrainMaximumWorkingWeekendsPerPlanningPeriod` | boolean | No | — | Whether to constrain the maximum working weekends in the planning period | | `constrainMinimumTimeBetweenShifts` | boolean | No | — | Whether the minimum time between shifts constraint is enabled for this work plan | | `constrainPaidTimeGranularity` | boolean | No | — | Whether paid time granularity should be constrained for this workplan | | `constrainWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is enabled for this work plan | | `enabled` | boolean | No | — | Whether the work plan is enabled for scheduling | | `flexibleWeeklyPaidTime` | boolean | No | — | Whether the weekly paid time constraint is flexible for this work plan | | `maximumConsecutiveWorkingDays` | integer | No | — | The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true | | `maximumConsecutiveWorkingWeekends` | integer | No | — | The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work | | `maximumDays` | integer | No | — | Maximum number days in a week allowed to be scheduled for this work plan | | `maximumDaysOffPerPlanningPeriod` | integer | No | — | Maximum days off in the planning period | | `maximumPaidMinutesPerPlanningPeriod` | integer | No | — | Maximum paid minutes in the planning period | | `maximumWorkingWeekendsPerPlanningPeriod` | integer | No | — | Maximum working weekends in the planning period | | `minimumConsecutiveNonWorkingMinutesPerWeek` | integer | No | — | Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off | | `minimumDaysOffPerPlanningPeriod` | integer | No | — | Minimum days off in the planning period | | `minimumPaidMinutesPerPlanningPeriod` | integer | No | — | Minimum paid minutes in the planning period | | `minimumShiftStartDistanceMinutes` | integer | No | — | The time period in minutes for the duration between the start times of two consecutive working days | | `minimumTimeBetweenShiftsMinutes` | integer | No | — | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | | `minimumWorkingDaysPerWeek` | integer | No | — | The minimum number of days that agents assigned to a work plan must work per week | | `name` | string | Yes | — | Name of this work plan | | `optionalDays` | object | No | — | Optional Days | | `paidTimeGranularityMinutes` | integer | No | — | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | | `shifts` | object\[] | No | — | Shifts in this work plan | | `shiftStartVariancePeriod` | string | No | — | The length of the period over which the maximum shift start time variance is applied | | `shiftStartVariances` | object | No | — | Shift Start Variances | | `shiftStartVarianceType` | string | No | — | This constraint ensures that an agent starts each workday within a user-defined time threshold | | `weeklyExactPaidMinutes` | integer | No | — | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | | `weeklyMaximumPaidMinutes` | integer | No | — | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | | `weeklyMinimumPaidMinutes` | integer | No | — | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "validationMode": { "type": "string", "description": "Allows to create work plan even if the validation result is invalid", "enum": [ "Ignore" ] }, "agents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } } }, "description": "Agents in this work plan" }, "constrainMaximumConsecutiveWorkingDays": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working days" }, "constrainMaximumConsecutiveWorkingWeekends": { "type": "boolean", "description": "Whether to constrain the maximum consecutive working weekends" }, "constrainMaximumWorkingWeekendsPerPlanningPeriod": { "type": "boolean", "description": "Whether to constrain the maximum working weekends in the planning period" }, "constrainMinimumTimeBetweenShifts": { "type": "boolean", "description": "Whether the minimum time between shifts constraint is enabled for this work plan" }, "constrainPaidTimeGranularity": { "type": "boolean", "description": "Whether paid time granularity should be constrained for this workplan" }, "constrainWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is enabled for this work plan" }, "enabled": { "type": "boolean", "description": "Whether the work plan is enabled for scheduling" }, "flexibleWeeklyPaidTime": { "type": "boolean", "description": "Whether the weekly paid time constraint is flexible for this work plan" }, "maximumConsecutiveWorkingDays": { "type": "integer", "description": "The maximum number of consecutive days that agents assigned to this work plan are allowed to work. Used if constrainMaximumConsecutiveWorkingDays == true" }, "maximumConsecutiveWorkingWeekends": { "type": "integer", "description": "The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work" }, "maximumDays": { "type": "integer", "description": "Maximum number days in a week allowed to be scheduled for this work plan" }, "maximumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Maximum days off in the planning period" }, "maximumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Maximum paid minutes in the planning period" }, "maximumWorkingWeekendsPerPlanningPeriod": { "type": "integer", "description": "Maximum working weekends in the planning period" }, "minimumConsecutiveNonWorkingMinutesPerWeek": { "type": "integer", "description": "Minimum amount of consecutive non working minutes per week that agents who are assigned this work plan are allowed to have off" }, "minimumDaysOffPerPlanningPeriod": { "type": "integer", "description": "Minimum days off in the planning period" }, "minimumPaidMinutesPerPlanningPeriod": { "type": "integer", "description": "Minimum paid minutes in the planning period" }, "minimumShiftStartDistanceMinutes": { "type": "integer", "description": "The time period in minutes for the duration between the start times of two consecutive working days" }, "minimumTimeBetweenShiftsMinutes": { "type": "integer", "description": "Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true" }, "minimumWorkingDaysPerWeek": { "type": "integer", "description": "The minimum number of days that agents assigned to a work plan must work per week" }, "name": { "type": "string", "description": "Name of this work plan" }, "optionalDays": { "type": "object", "description": "Optional Days", "properties": { "values": { "type": "array", "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "description": "The values value" } } }, "paidTimeGranularityMinutes": { "type": "integer", "description": "Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true" }, "shifts": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the shift" }, "days": { "type": "object", "description": "The days value" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the shift is flexible" }, "exactStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false" }, "earliestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true" }, "constrainStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled. Deprecated, use constrainLatestStopTime instead" }, "constrainLatestStopTime": { "type": "boolean", "description": "Whether the latest stop time constraint for the shift is enabled" }, "latestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true" }, "constrainEarliestStopTime": { "type": "boolean", "description": "Whether the earliest stop time constraint for the shift is enabled" }, "earliestStopTimeMinutesFromMidnight": { "type": "integer", "format": "int32", "description": "This is the earliest time a shift can end" }, "startIncrementMinutes": { "type": "integer", "format": "int32", "description": "Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true" }, "flexiblePaidTime": { "type": "boolean", "description": "Whether the paid time setting for the shift is flexible" }, "exactPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false" }, "minimumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "maximumPaidTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true" }, "constrainContiguousWorkTime": { "type": "boolean", "description": "Whether the contiguous time constraint for the shift is enabled" }, "minimumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "maximumContiguousWorkTimeMinutes": { "type": "integer", "format": "int32", "description": "Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true" }, "constrainDayOff": { "type": "boolean", "description": "Whether day off rule is enabled" }, "dayOffRule": { "type": "string", "enum": [ "NextDayOff", "PreviousDayOff" ], "description": "The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true" }, "planningPeriodConstraints": { "type": "object", "description": "Planning Period Constraints" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "activityCodeId": { "type": "string", "description": "ID of the activity code associated with this activity" }, "description": { "type": "string", "description": "Description of the activity" }, "lengthMinutes": { "type": "integer", "description": "Length of the activity in minutes" }, "startTimeIsRelativeToShiftStart": { "type": "boolean", "description": "Whether the start time of the activity is relative to the start time of the shift it belongs to" }, "flexibleStartTime": { "type": "boolean", "description": "Whether the start time of the activity is flexible" }, "earliestStartTimeMinutes": { "type": "integer", "description": "Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "latestStartTimeMinutes": { "type": "integer", "description": "Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true" }, "exactStartTimeMinutes": { "type": "integer", "description": "Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false" }, "startTimeIncrementMinutes": { "type": "integer", "description": "Increment in offset minutes that would contribute to different possible start times for the activity" }, "countsAsPaidTime": { "type": "boolean", "description": "Whether the activity is paid" }, "countsAsContiguousWorkTime": { "type": "boolean", "description": "Whether the activity duration is counted towards contiguous work time" }, "minimumLengthFromShiftStartMinutes": { "type": "integer", "description": "The minimum duration between shift start and shift item (e.g., break or meal) start in minutes" }, "minimumLengthFromShiftEndMinutes": { "type": "integer", "description": "The minimum duration between shift item (e.g., break or meal) end and shift end in minutes" }, "maximumLengthFromShiftEndMinutes": { "type": "integer", "description": "The maximum duration between shift item (e.g., break or meal) end and shift end in minutes" } } }, "description": "Activities configured for this shift" } }, "required": [ "name" ] }, "description": "Shifts in this work plan" }, "shiftStartVariancePeriod": { "type": "string", "description": "The length of the period over which the maximum shift start time variance is applied", "enum": [ "Weekly", "PlanningPeriod" ] }, "shiftStartVariances": { "type": "object", "description": "Shift Start Variances", "properties": { "values": { "type": "array", "items": { "type": "object" }, "description": "The values value" } } }, "shiftStartVarianceType": { "type": "string", "description": "This constraint ensures that an agent starts each workday within a user-defined time threshold", "enum": [ "ShiftStart", "ShiftStartAndPaidDuration" ] }, "weeklyExactPaidMinutes": { "type": "integer", "description": "Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false" }, "weeklyMaximumPaidMinutes": { "type": "integer", "description": "Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" }, "weeklyMinimumPaidMinutes": { "type": "integer", "description": "Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true" } }, "required": [ "PCID", "managementUnitId", "name" ] } ``` *** ## genesys\_workforce\_post\_managementunits Add a management unit **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------- | | `businessUnitId` | string | Yes | — | The id of the business unit to which this management unit belongs | | `divisionId` | string | No | — | The id of the division to which this management unit belongs. Defaults to home division ID | | `name` | string | Yes | — | The name of the management unit | | `settings` | object | No | — | The settings value | | `startDayOfWeek` | string | No | — | The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit | | `timeZone` | string | No | — | The default time zone to use for this management unit. Moving to Business Unit | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "businessUnitId": { "type": "string", "description": "The id of the business unit to which this management unit belongs" }, "divisionId": { "type": "string", "description": "The id of the division to which this management unit belongs. Defaults to home division ID" }, "name": { "type": "string", "description": "The name of the management unit" }, "settings": { "type": "object", "description": "The settings value", "properties": { "adherence": { "type": "object", "description": "The adherence value" }, "shortTermForecasting": { "type": "object", "description": "Short Term Forecasting" }, "timeOff": { "type": "object", "description": "Time Off" }, "scheduling": { "type": "object", "description": "The scheduling value" }, "shiftTrading": { "type": "object", "description": "Shift Trading" } } }, "startDayOfWeek": { "type": "string", "description": "The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "timeZone": { "type": "string", "description": "The default time zone to use for this management unit. Moving to Business Unit" } }, "required": [ "PCID", "businessUnitId", "name" ] } ``` *** ## genesys\_workforce\_post\_notifications\_update Mark a list of notifications as read or unread **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | --------- | -------- | ------- | --------------------------- | | `entities` | object\[] | Yes | — | The notifications to update | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The immutable globally unique identifier for the object." }, "mutableGroupId": { "type": "string", "description": "The group ID of the notification (mutable, may change on update)" }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp for this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "type": { "type": "string", "enum": [ "AdherenceExplanation", "ShiftTrade", "TimeOffRequest", "AlternativeShift" ], "description": "The type of this notification" }, "shiftTrade": { "type": "object", "description": "Shift Trade" }, "timeOffRequest": { "type": "object", "description": "Time Off Request" }, "adherenceExplanation": { "type": "object", "description": "Adherence Explanation" }, "alternativeShift": { "type": "object", "description": "Alternative Shift" }, "markedAsRead": { "type": "boolean", "description": "Whether this notification has been marked \"read\"" }, "agentNotification": { "type": "boolean", "description": "Whether this notification is for an agent" }, "otherNotificationIdsInGroup": { "type": "array", "items": { "type": "string" }, "description": "Other notification IDs in group. This field is only populated in real-time notifications" } }, "required": [ "id", "markedAsRead", "mutableGroupId" ] }, "description": "The notifications to update" } }, "required": [ "PCID", "entities" ] } ``` *** ## genesys\_workforce\_post\_team\_adherence\_historical Request a teams historical adherence report **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | string | Yes | — | The ID of the team | | `endDate` | string | No | — | End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time | | `includeExceptions` | boolean | No | — | Whether user exceptions should be returned as part of the results | | `startDate` | string | Yes | — | Beginning of the date range to query in ISO-8601 format | | `timeZone` | string | Yes | — | The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input. | | `userIds` | string\[] | No | — | The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "string", "description": "The ID of the team" }, "endDate": { "type": "string", "description": "End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time" }, "includeExceptions": { "type": "boolean", "description": "Whether user exceptions should be returned as part of the results" }, "startDate": { "type": "string", "description": "Beginning of the date range to query in ISO-8601 format" }, "timeZone": { "type": "string", "description": "The time zone, in olson format, to use in defining days when computing adherence. The results will be returned as UTC timestamps regardless of the time zone input." }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "The userIds to report on. If null or not set, adherence will be computed for all the users in management unit or requested teamIds" } }, "required": [ "PCID", "teamId", "startDate", "timeZone" ] } ``` *** ## genesys\_workforce\_post\_timeoffbalance\_jobs Query time off balances for the current user for specified activity code and dates **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------- | | `activityCodeIds` | string\[] | Yes | — | The set of activity code IDs for which to query available time off balances | | `dateRanges` | object\[] | No | — | The list of date ranges for which to query time off balance | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeIds": { "type": "array", "items": { "type": "string" }, "description": "The set of activity code IDs for which to query available time off balances" }, "dateRanges": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endDate": { "type": "string", "format": "date", "description": "The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } } }, "description": "The list of date ranges for which to query time off balance" } }, "required": [ "PCID", "activityCodeIds" ] } ``` *** ## genesys\_workforce\_post\_timeofflimits\_available\_query Queries available time off for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activityCodeId` | string | Yes | — | The ID for activity code to query available time off minutes | | `dateRanges` | object\[] | No | — | A list of date ranges of available time off minutes. A maximum number of date ranges is 30. The maximum total number of days in all ranges is 366. If no ranges are specified, then only the presence of the associated time off limit object will be checked. In such case, if the association exists, then the response will contain a list with of a single element filled with timeOffLimitId only. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeId": { "type": "string", "description": "The ID for activity code to query available time off minutes" }, "dateRanges": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "The inclusive start of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "endDate": { "type": "string", "format": "date", "description": "The inclusive end of a date range in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } } }, "description": "A list of date ranges of available time off minutes. A maximum number of date ranges is 30. The maximum total number of days in all ranges is 366. If no ranges are specified, then only the presence of the associated time off limit object will be checked. In such case, if the association exists, then the response will contain a list with of a single element filled with timeOffLimitId only." } }, "required": [ "PCID", "activityCodeId" ] } ``` *** ## genesys\_workforce\_post\_timeoffrequests Create a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `activityCodeId` | string | Yes | — | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | | `dailyDurationMinutes` | integer | No | — | Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required | | `durationMinutes` | integer\[] | No | — | Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required | | `fullDayEarliestStartOffsetMinutes` | integer\[] | No | — | Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available | | `fullDayLatestEndOffsetMinutes` | integer\[] | No | — | Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available | | `fullDayManagementUnitDates` | string\[] | No | — | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone | | `notes` | string | No | — | Notes about the time off request | | `partialDayStartDateTimes` | string\[] | No | — | A set of start date-times in ISO-8601 format for partial day requests | | `payableMinutes` | integer\[] | No | — | Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category" }, "dailyDurationMinutes": { "type": "integer", "description": "Daily duration in minutes applied to all days of this time off request. Ignored if durationMinutes is specified. At least one of dailyDurationMinutes or durationMinutes is required" }, "durationMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Duration in minutes for each day of this time off request. Must match the size of fullDayManagementUnitDates or partialDayStartDateTimes. At least one of dailyDurationMinutes or durationMinutes is required" }, "fullDayEarliestStartOffsetMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Earliest start offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available" }, "fullDayLatestEndOffsetMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Latest end offset in minutes for each full-day request date. Values may be null when time-off estimation is disabled or no estimate is available" }, "fullDayManagementUnitDates": { "type": "array", "items": { "type": "string" }, "description": "A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone" }, "notes": { "type": "string", "description": "Notes about the time off request" }, "partialDayStartDateTimes": { "type": "array", "items": { "type": "string", "format": "date-time" }, "description": "A set of start date-times in ISO-8601 format for partial day requests" }, "payableMinutes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Payable minutes for each day of this time off request, representing scheduled paid time displaced by this request. Defaults to dailyDurationMinutes if not specified" } }, "required": [ "PCID", "activityCodeId" ] } ``` *** ## genesys\_workforce\_post\_timeoffrequests\_estimate Estimates available time off for current user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- | | `includeOnly` | string | No | — | Limit response to the specified field | | `activityCodeId` | string | Yes | — | The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category | | `fullDayDates` | object\[] | No | — | Full day dates. partialDayDates must be empty if this field is populated | | `paid` | boolean | Yes | — | Whether this estimate is for a paid time off request | | `partialDayDates` | object\[] | No | — | Partial day dates. fullDayDates must be empty if this field is populated | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includeOnly": { "type": "string", "description": "Limit response to the specified field", "enum": [ "overrideDateType" ] }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category" }, "fullDayDates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "description": "Date in yyyy-MM-dd format for full day request. Should be interpreted in the business unit's configured time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "requestedDurationMinutes": { "type": "integer", "format": "int32", "description": "A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting" } }, "required": [ "date" ] }, "description": "Full day dates. partialDayDates must be empty if this field is populated" }, "paid": { "type": "boolean", "description": "Whether this estimate is for a paid time off request" }, "partialDayDates": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "Start date-time in ISO-8601 format for partial day request" }, "requestedDurationMinutes": { "type": "integer", "format": "int32", "description": "A requested length of time off request in minutes. If the value is null, then the system will use activity code length setting" } }, "required": [ "date" ] }, "description": "Partial day dates. fullDayDates must be empty if this field is populated" } }, "required": [ "PCID", "activityCodeId", "paid" ] } ``` *** ## genesys\_workforce\_post\_timeoffrequests\_integrationstatus\_query Retrieves integration statuses for a list of current user time off requests **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------ | | `timeOffRequestIds` | string\[] | Yes | — | A list of time off request IDs | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "timeOffRequestIds": { "type": "array", "items": { "type": "string" }, "description": "A list of time off request IDs" } }, "required": [ "PCID", "timeOffRequestIds" ] } ``` *** ## genesys\_workforce\_post\_workforcemanagement\_agentschedules\_mine Get published schedule for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `endDate` | string | Yes | — | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "endDate": { "type": "string", "description": "End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" } }, "required": [ "PCID", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_workforcemanagement\_managementunit\_agentschedules\_search Query published schedules for given given time range for set of users **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `forceAsync` | boolean | No | — | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `endDate` | string | Yes | — | End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `startDate` | string | Yes | — | Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `userIds` | any\[] | No | — | IDs of the users for whose schedules to search | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "forceAsync": { "type": "boolean", "description": "Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes" }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "endDate": { "type": "string", "description": "End date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "startDate": { "type": "string", "description": "Start date of the range to search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "userIds": { "type": "array", "description": "IDs of the users for whose schedules to search" } }, "required": [ "PCID", "managementUnitId", "endDate", "startDate" ] } ``` *** ## genesys\_workforce\_post\_workforcemanagement\_managementunit\_timeoffrequests\_query Fetches time off requests matching the conditions specified in the request body **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | `forceDownloadService` | boolean | No | — | Force the result of this operation to be sent via download service. For testing/app development purposes | | `dateRange` | object | No | — | dateRange | | `ids` | any\[] | No | — | The set of ids to filter time off requests | | `statuses` | any\[] | No | — | The set of statuses to filter time off requests | | `substatuses` | any\[] | No | — | The set of substatuses to filter time off requests | | `userIds` | any\[] | No | — | The set of user ids to filter time off requests | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit, or 'mine' for the management unit of the logged-in user." }, "forceDownloadService": { "type": "boolean", "description": "Force the result of this operation to be sent via download service. For testing/app development purposes" }, "dateRange": { "type": "object", "description": "dateRange" }, "ids": { "type": "array", "description": "The set of ids to filter time off requests" }, "statuses": { "type": "array", "description": "The set of statuses to filter time off requests" }, "substatuses": { "type": "array", "description": "The set of substatuses to filter time off requests" }, "userIds": { "type": "array", "description": "The set of user ids to filter time off requests" } }, "required": [ "PCID", "managementUnitId" ] } ``` *** ## genesys\_workforce\_post\_workforcemanagement\_timeoffrequests Create a time off request for the current user **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | `activityCodeId` | string | Yes | — | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | | `dailyDurationMinutes` | integer | Yes | — | The daily duration of this time off request in minutes | | `durationMinutes` | any\[] | No | — | Daily durations for each day of this time off request in minutes | | `fullDayManagementUnitDates` | any\[] | No | — | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. | | `notes` | string | No | — | Notes about the time off request | | `partialDayStartDateTimes` | any\[] | No | — | A set of start date-times in ISO-8601 format for partial day requests. | | `payableMinutes` | any\[] | No | — | Payable minutes for each day of this time off request | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "activityCodeId": { "type": "string", "description": "The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category" }, "dailyDurationMinutes": { "type": "integer", "description": "The daily duration of this time off request in minutes" }, "durationMinutes": { "type": "array", "description": "Daily durations for each day of this time off request in minutes" }, "fullDayManagementUnitDates": { "type": "array", "description": "A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone." }, "notes": { "type": "string", "description": "Notes about the time off request" }, "partialDayStartDateTimes": { "type": "array", "description": "A set of start date-times in ISO-8601 format for partial day requests." }, "payableMinutes": { "type": "array", "description": "Payable minutes for each day of this time off request" } }, "required": [ "PCID", "activityCodeId", "dailyDurationMinutes" ] } ``` *** ## genesys\_workforce\_put\_managementunit\_timeofflimit\_values Sets daily values for a date range of time off limit object **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ----------------------------------------------------- | | `managementUnitId` | string | Yes | — | The ID of the management unit. | | `timeOffLimitId` | string | Yes | — | The ID of the time off limit object to set values for | | `metadata` | object | Yes | — | The metadata value | | `values` | object\[] | No | — | The values value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "managementUnitId": { "type": "string", "description": "The ID of the management unit." }, "timeOffLimitId": { "type": "string", "description": "The ID of the time off limit object to set values for" }, "metadata": { "type": "object", "description": "The metadata value", "properties": { "modifiedBy": { "type": "object", "description": "Modified By" }, "dateModified": { "type": "string", "description": "The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "dateCreated": { "type": "string", "description": "The date the associated entity was created, if available. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "version": { "type": "integer", "description": "The version of the associated entity. Used to prevent conflicts on concurrent edits" } }, "required": [ "version" ] }, "values": { "type": "array", "items": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "description": "Start date of the range. The end date is determined by 'granularity' and the size of 'limitMinutesPerInterval'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "granularity": { "type": "string", "enum": [ "Daily", "FifteenMinutes" ], "description": "Granularity choice for the time-off limit" }, "limitMinutesPerInterval": { "type": "array", "items": { "type": "integer" }, "description": "The list of time off limit values in minutes per granularity interval. If 'null' is specified, then interval specific value is cleared. Such interval will have 'defaultLimitMinutes' value" } }, "required": [ "granularity", "limitMinutesPerInterval", "startDate" ] }, "description": "The values value" } }, "required": [ "PCID", "managementUnitId", "timeOffLimitId", "metadata" ] } ```