genesys-workforce - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-workforce | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys_workforce_delete_managementunit`	Delete management unit
`genesys_workforce_delete_managementunit_timeofflimit`	Deletes a time off limit object
`genesys_workforce_delete_managementunit_timeoffplan`	Deletes a time off plan
`genesys_workforce_delete_managementunit_workplan`	Delete a work plan
`genesys_workforce_delete_managementunit_workplanrotation`	Delete a work plan rotation
`genesys_workforce_get_adherence`	Get a list of UserScheduleAdherence records for the requested users
`genesys_workforce_get_adherence_explanation`	Get an adherence explanation for the current user
`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`	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`	Get an adherence explanation
`genesys_workforce_get_agent_managementunit`	Get the management unit to which the agent belongs
`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`	Get the management unit to which the currently logged in agent belongs
`genesys_workforce_get_managementunit`	Get management unit
`genesys_workforce_get_managementunit_adherence`	Get a list of user schedule adherence records for the requested management unit
`genesys_workforce_get_managementunit_agent`	Get data for agent in the management unit
`genesys_workforce_get_managementunit_agent_shifttrades`	Gets all the shift trades for a given agent
`genesys_workforce_get_managementunit_shifttrades_matched`	Gets a summary of all shift trades in the matched state
`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`	Gets a time off limit object
`genesys_workforce_get_managementunit_timeofflimits`	Gets a list of time off limit objects under management unit.
`genesys_workforce_get_managementunit_timeoffplan`	Gets a time off plan
`genesys_workforce_get_managementunit_timeoffplans`	Gets a list of time off plans
`genesys_workforce_get_managementunit_user_timeoffrequest`	Get a time off request
`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`	Get a list of time off requests for a given user
`genesys_workforce_get_managementunit_users`	Get users in the management unit
`genesys_workforce_get_managementunit_week_shifttrades`	Gets all the shift trades for a given week
`genesys_workforce_get_managementunit_workplan`	Get a work plan
`genesys_workforce_get_managementunit_workplanrotation`	Get a work plan rotation
`genesys_workforce_get_managementunit_workplanrotations`	Get work plan rotations
`genesys_workforce_get_managementunit_workplans`	Get work plans
`genesys_workforce_get_managementunits`	Get management units
`genesys_workforce_get_notifications`	Get a list of notifications for the current user
`genesys_workforce_get_shifttrades`	Gets all of my shift trades
`genesys_workforce_get_team_adherence`	Get a list of user schedule adherence records for the requested team
`genesys_workforce_get_timeoffbalance_job`	Query the results of time off types job
`genesys_workforce_get_timeoffrequest`	Get a time off request for the current user
`genesys_workforce_get_timeoffrequest_waitlistpositions`	Get the daily waitlist positions of a time off request for the current user
`genesys_workforce_get_timeoffrequests`	Get a list of time off requests for the current user
`genesys_workforce_get_workforcemanagement_adherence`	Get a list of UserScheduleAdherence records for the requested users
`genesys_workforce_get_workforcemanagement_managementunit`	Get management unit
`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`	Get data for agent in the management unit
`genesys_workforce_get_workforcemanagement_managementunit_user_timeoffrequests`	Get a list of time off requests for a given user
`genesys_workforce_get_workforcemanagement_managementunit_users`	Get users in the management unit
`genesys_workforce_get_workforcemanagement_managementunits`	Get management units
`genesys_workforce_get_workforcemanagement_notifications`	Get a list of notifications for the current user
`genesys_workforce_get_workforcemanagement_team_adherence`	Get a list of user schedule adherence records for the requested team
`genesys_workforce_get_workforcemanagement_timeoffrequest`	Get a time off request for the current user
`genesys_workforce_get_workforcemanagement_timeoffrequests`	Get a list of time off requests for the current user
`genesys_workforce_patch_agent_adherence_explanation`	Update an adherence explanation
`genesys_workforce_patch_managementunit`	Update the requested management unit
`genesys_workforce_patch_managementunit_agents`	Update agent configurations
`genesys_workforce_patch_managementunit_timeofflimit`	Updates a time off limit object.
`genesys_workforce_patch_managementunit_timeoffplan`	Updates a time off plan
`genesys_workforce_patch_managementunit_timeoffrequest_user_integrationstatus`	Set integration status for a time off request.
`genesys_workforce_patch_managementunit_user_timeoffrequest`	Update a time off request
`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`	Update a work plan
`genesys_workforce_patch_managementunit_workplanrotation`	Update a work plan rotation
`genesys_workforce_patch_timeoffrequest`	Update a time off request for the current user
`genesys_workforce_post_adherence_explanations`	Submit an adherence explanation for the current user
`genesys_workforce_post_adherence_explanations_query`	Query adherence explanations for the current user
`genesys_workforce_post_agent_adherence_explanations`	Add an adherence explanation for the requested user
`genesys_workforce_post_agent_adherence_explanations_query`	Query adherence explanations for the given agent across a specified range
`genesys_workforce_post_agents`	Move agents in and out of management unit
`genesys_workforce_post_agents_me_adherence_historical_jobs`	Request an agent historical adherence report
`genesys_workforce_post_agents_me_possibleworkshifts`	Get agent possible work shifts for requested time frame
`genesys_workforce_post_agentschedules_managementunits_mine`	Fetch agent schedules for the logged in user’s management unit
`genesys_workforce_post_agentschedules_mine`	Get published schedule for the current user
`genesys_workforce_post_managementunit_agents_workplans_query`	Get agents work plans configuration
`genesys_workforce_post_managementunit_agentschedules_search`	Query published schedules for given given time range for set of users
`genesys_workforce_post_managementunit_historicaladherencequery`	Request a historical adherence report
`genesys_workforce_post_managementunit_move`	Move the requested management unit to a new business unit
`genesys_workforce_post_managementunit_timeofflimits`	Creates a new time off limit object under management unit.
`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`	Creates a new time off plan
`genesys_workforce_post_managementunit_timeoffrequests`	Create a new time off request
`genesys_workforce_post_managementunit_timeoffrequests_integrationstatus_query`	Retrieves integration statuses for a list of time off requests
`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`	Retrieves daily waitlist position for a list of time off requests
`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`	Query time off balances for dates spanned by a given time off request
`genesys_workforce_post_managementunit_user_timeoffrequests_estimate`	Estimates available time off for an agent
`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`	Adds a shift trade
`genesys_workforce_post_managementunit_week_shifttrades_search`	Searches for potential shift trade matches for the current agent
`genesys_workforce_post_managementunit_workplan_copy`	Create a copy of work plan
`genesys_workforce_post_managementunit_workplan_validate`	Validate Work Plan
`genesys_workforce_post_managementunit_workplanrotation_copy`	Create a copy of work plan rotation
`genesys_workforce_post_managementunit_workplanrotations`	Create a new work plan rotation
`genesys_workforce_post_managementunit_workplans`	Create a new work plan
`genesys_workforce_post_managementunits`	Add a management unit
`genesys_workforce_post_notifications_update`	Mark a list of notifications as read or unread
`genesys_workforce_post_team_adherence_historical`	Request a teams historical adherence report
`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`	Queries available time off for the current user
`genesys_workforce_post_timeoffrequests`	Create a time off request for the current user
`genesys_workforce_post_timeoffrequests_estimate`	Estimates available time off for current user
`genesys_workforce_post_timeoffrequests_integrationstatus_query`	Retrieves integration statuses for a list of current user time off requests
`genesys_workforce_post_workforcemanagement_agentschedules_mine`	Get published schedule for the current user
`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`	Fetches time off requests matching the conditions specified in the request body
`genesys_workforce_post_workforcemanagement_timeoffrequests`	Create a time off request for the current user
`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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	Yes	—	User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request

Show inputSchema

{
  "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_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

Show inputSchema

{
  "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

Show inputSchema

{
  "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	—	jobId

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    }
  },
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	No	—	expand

Show inputSchema

{
  "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_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

Show inputSchema

{
  "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`	any[]	No	—	expand

Show inputSchema

{
  "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_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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	No	—	limit response to the specified fields

Show inputSchema

{
  "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",
      "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

Show inputSchema

{
  "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`	any[]	No	—	expand

Show inputSchema

{
  "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_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`	any[]	No	—	Include to access additional data on the work plans
`exclude`	any[]	No	—	Exclude specific data on the work plans from the response

Show inputSchema

{
  "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": "Include to access additional data on the work plans"
    },
    "exclude": {
      "type": "array",
      "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

Show inputSchema

{
  "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_notifications

Get a list of notifications for the current user

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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.

Show inputSchema

{
  "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.

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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	—	settings

Show inputSchema

{
  "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": "settings"
    }
  },
  "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`	any[]	No	—	List of agents to update

Show inputSchema

{
  "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",
      "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	—	metadata

Show inputSchema

{
  "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": "metadata"
    }
  },
  "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	—	activityCodeIds
`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	—	hrisTimeOffType
`metadata`	object	Yes	—	metadata
`name`	string	No	—	The name of this time off plan.
`timeOffLimitIds`	object	No	—	timeOffLimitIds

Show inputSchema

{
  "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": "activityCodeIds"
    },
    "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": "hrisTimeOffType"
    },
    "metadata": {
      "type": "object",
      "description": "metadata"
    },
    "name": {
      "type": "string",
      "description": "The name of this time off plan."
    },
    "timeOffLimitIds": {
      "type": "object",
      "description": "timeOffLimitIds"
    }
  },
  "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

Show inputSchema

{
  "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`	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.
`metadata`	object	Yes	—	metadata
`notes`	string	No	—	Notes about the time off request
`paid`	boolean	No	—	Whether this is a paid 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
`status`	string	No	—	The status of this time off request

Show inputSchema

{
  "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",
      "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."
    },
    "metadata": {
      "type": "object",
      "description": "metadata"
    },
    "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",
      "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"
    },
    "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	—	acceptableIntervals
`expiration`	object	No	—	expiration
`metadata`	object	Yes	—	metadata
`receivingUserId`	object	No	—	receivingUserId

Show inputSchema

{
  "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": "acceptableIntervals"
    },
    "expiration": {
      "type": "object",
      "description": "expiration"
    },
    "metadata": {
      "type": "object",
      "description": "metadata"
    },
    "receivingUserId": {
      "type": "object",
      "description": "receivingUserId"
    }
  },
  "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`	any[]	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	No	—	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	—	metadata
`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	—	name
`optionalDays`	object	No	—	optionalDays
`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`	any[]	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	—	shiftStartVariances
`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

Show inputSchema

{
  "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",
      "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": "metadata"
    },
    "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"
    },
    "optionalDays": {
      "type": "object",
      "description": "optionalDays"
    },
    "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",
      "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": "shiftStartVariances"
    },
    "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",
    "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`	any[]	No	—	Agents in this work plan rotation
`dateRange`	object	No	—	dateRange
`enabled`	boolean	No	—	Whether the work plan rotation is enabled for scheduling
`metadata`	object	Yes	—	metadata
`name`	string	No	—	Name of this work plan rotation
`pattern`	object	No	—	pattern

Show inputSchema

{
  "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",
      "description": "Agents in this work plan rotation"
    },
    "dateRange": {
      "type": "object",
      "description": "dateRange"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the work plan rotation is enabled for scheduling"
    },
    "metadata": {
      "type": "object",
      "description": "metadata"
    },
    "name": {
      "type": "string",
      "description": "Name of this work plan rotation"
    },
    "pattern": {
      "type": "object",
      "description": "pattern"
    }
  },
  "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
`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

Show inputSchema

{
  "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"
    },
    "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	Yes	—	The list of user ids to move

Show inputSchema

{
  "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",
      "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`	any[]	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	No	—	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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "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"
  ]
}

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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	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

Show inputSchema

{
  "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",
      "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`	any[]	No	—	IDs of the users for whose schedules to search

Show inputSchema

{
  "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_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`	any[]	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`	any[]	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

Show inputSchema

{
  "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",
      "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",
      "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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`	any[]	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

Show inputSchema

{
  "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",
      "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`	any[]	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	—	hrisTimeOffType
`name`	string	Yes	—	The name of this time off plan.
`timeOffLimitIds`	any[]	No	—	The set of time off limit IDs to associate with this time off plan.

Show inputSchema

{
  "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",
      "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": "hrisTimeOffType"
    },
    "name": {
      "type": "string",
      "description": "The name of this time off plan."
    },
    "timeOffLimitIds": {
      "type": "array",
      "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	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
`paid`	boolean	No	—	Whether this is a paid 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
`status`	string	Yes	—	The status of this time off request
`users`	any[]	Yes	—	A set of IDs for users to associate with this time off request

Show inputSchema

{
  "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": "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"
    },
    "paid": {
      "type": "boolean",
      "description": "Whether this is a paid 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"
    },
    "status": {
      "type": "string",
      "description": "The status of this time off request",
      "enum": [
        "PENDING",
        "APPROVED"
      ]
    },
    "users": {
      "type": "array",
      "description": "A set of IDs for users to associate with this time off request"
    }
  },
  "required": [
    "PCID",
    "managementUnitId",
    "activityCodeId",
    "dailyDurationMinutes",
    "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`	any[]	Yes	—	A list of time off request lookups

Show inputSchema

{
  "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",
      "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	—	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

Show inputSchema

{
  "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_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`	any[]	Yes	—	The list of the time off request ids for which to fetch the daily waitlist positions

Show inputSchema

{
  "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",
      "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`	any[]	Yes	—	The set of activity code IDs for which to query available time off balances
`dateRanges`	any[]	No	—	The list of date ranges for which to query time off balance

Show inputSchema

{
  "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",
      "description": "The set of activity code IDs for which to query available time off balances"
    },
    "dateRanges": {
      "type": "array",
      "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.

Show inputSchema

{
  "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
`activityCodeId`	string	Yes	—	The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category
`fullDayDates`	any[]	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`	any[]	No	—	Partial day dates. fullDayDates must be empty if this field is populated

Show inputSchema

{
  "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"
    },
    "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",
      "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",
      "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	—	metadata
`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

Show inputSchema

{
  "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": "metadata"
    },
    "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`	any[]	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

Show inputSchema

{
  "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",
      "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`	any[]	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)

Show inputSchema

{
  "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",
      "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

Show inputSchema

{
  "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`	any[]	No	—	expand
`agentCount`	integer	No	—	Number of agents in this work plan
`agents`	any[]	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	No	—	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	—	name
`optionalDays`	object	No	—	optionalDays
`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`	any[]	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	—	shiftStartVariances
`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

Show inputSchema

{
  "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",
      "description": "expand"
    },
    "agentCount": {
      "type": "integer",
      "description": "Number of agents in this work plan"
    },
    "agents": {
      "type": "array",
      "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": "name"
    },
    "optionalDays": {
      "type": "object",
      "description": "optionalDays"
    },
    "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",
      "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": "shiftStartVariances"
    },
    "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"
  ]
}

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

Show inputSchema

{
  "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`	any[]	No	—	Agents in this work plan rotation
`dateRange`	object	Yes	—	dateRange
`name`	string	Yes	—	Name of this work plan rotation
`pattern`	object	Yes	—	pattern

Show inputSchema

{
  "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",
      "description": "Agents in this work plan rotation"
    },
    "dateRange": {
      "type": "object",
      "description": "dateRange"
    },
    "name": {
      "type": "string",
      "description": "Name of this work plan rotation"
    },
    "pattern": {
      "type": "object",
      "description": "pattern"
    }
  },
  "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`	any[]	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	—	optionalDays
`paidTimeGranularityMinutes`	integer	No	—	Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true
`shifts`	any[]	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	—	shiftStartVariances
`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

Show inputSchema

{
  "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",
      "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": "optionalDays"
    },
    "paidTimeGranularityMinutes": {
      "type": "integer",
      "description": "Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true"
    },
    "shifts": {
      "type": "array",
      "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": "shiftStartVariances"
    },
    "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	—	settings
`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

Show inputSchema

{
  "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": "settings"
    },
    "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`	any[]	Yes	—	The notifications to update

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "entities": {
      "type": "array",
      "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`	any[]	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

Show inputSchema

{
  "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",
      "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`	any[]	Yes	—	The set of activity code IDs for which to query available time off balances
`dateRanges`	any[]	No	—	The list of date ranges for which to query time off balance

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "activityCodeIds": {
      "type": "array",
      "description": "The set of activity code IDs for which to query available time off balances"
    },
    "dateRanges": {
      "type": "array",
      "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`	any[]	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.

Show inputSchema

{
  "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",
      "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	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

Show inputSchema

{
  "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_post_timeoffrequests_estimate

Estimates available time off for current user Parameters:

Parameter	Type	Required	Default	Description
`activityCodeId`	string	Yes	—	The ID of the activity code associated with the time off request. Activity code must be of the TimeOff category
`fullDayDates`	any[]	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`	any[]	No	—	Partial day dates. fullDayDates must be empty if this field is populated

Show inputSchema

{
  "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 the time off request. Activity code must be of the TimeOff category"
    },
    "fullDayDates": {
      "type": "array",
      "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",
      "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`	any[]	Yes	—	A list of time off request IDs

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "timeOffRequestIds": {
      "type": "array",
      "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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

Show inputSchema

{
  "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	—	metadata
`values`	any[]	No	—	values

Show inputSchema

{
  "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": "metadata"
    },
    "values": {
      "type": "array",
      "description": "values"
    }
  },
  "required": [
    "PCID",
    "managementUnitId",
    "timeOffLimitId",
    "metadata"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_workforce_delete_managementunit

​genesys_workforce_delete_managementunit_timeofflimit

​genesys_workforce_delete_managementunit_timeoffplan

​genesys_workforce_delete_managementunit_workplan

​genesys_workforce_delete_managementunit_workplanrotation

​genesys_workforce_get_adherence

​genesys_workforce_get_adherence_explanation

​genesys_workforce_get_adherence_explanations_job

​genesys_workforce_get_adherence_historical_job

​genesys_workforce_get_agent_adherence_explanation

​genesys_workforce_get_agent_managementunit

​genesys_workforce_get_agents_me_adherence_historical_job

​genesys_workforce_get_agents_me_managementunit

​genesys_workforce_get_managementunit

​genesys_workforce_get_managementunit_adherence

​genesys_workforce_get_managementunit_agent

​genesys_workforce_get_managementunit_agent_shifttrades

​genesys_workforce_get_managementunit_shifttrades_matched

​genesys_workforce_get_managementunit_shifttrades_users

​genesys_workforce_get_managementunit_timeofflimit

​genesys_workforce_get_managementunit_timeofflimits

​genesys_workforce_get_managementunit_timeoffplan

​genesys_workforce_get_managementunit_timeoffplans

​genesys_workforce_get_managementunit_user_timeoffrequest

​genesys_workforce_get_managementunit_user_timeoffrequest_timeofflimits

​genesys_workforce_get_managementunit_user_timeoffrequests

​genesys_workforce_get_managementunit_users

​genesys_workforce_get_managementunit_week_shifttrades

​genesys_workforce_get_managementunit_workplan

​genesys_workforce_get_managementunit_workplanrotation

​genesys_workforce_get_managementunit_workplanrotations

​genesys_workforce_get_managementunit_workplans

​genesys_workforce_get_managementunits

​genesys_workforce_get_notifications

​genesys_workforce_get_shifttrades

​genesys_workforce_get_team_adherence

​genesys_workforce_get_timeoffbalance_job

​genesys_workforce_get_timeoffrequest

​genesys_workforce_get_timeoffrequest_waitlistpositions

​genesys_workforce_get_timeoffrequests

​genesys_workforce_get_workforcemanagement_adherence

​genesys_workforce_get_workforcemanagement_managementunit

​genesys_workforce_get_workforcemanagement_managementunit_adherence

​genesys_workforce_get_workforcemanagement_managementunit_agent

​genesys_workforce_get_workforcemanagement_managementunit_user_timeoffrequests

​genesys_workforce_get_workforcemanagement_managementunit_users

​genesys_workforce_get_workforcemanagement_managementunits

​genesys_workforce_get_workforcemanagement_notifications

​genesys_workforce_get_workforcemanagement_team_adherence

​genesys_workforce_get_workforcemanagement_timeoffrequest

​genesys_workforce_get_workforcemanagement_timeoffrequests

​genesys_workforce_patch_agent_adherence_explanation

​genesys_workforce_patch_managementunit

​genesys_workforce_patch_managementunit_agents

​genesys_workforce_patch_managementunit_timeofflimit

​genesys_workforce_patch_managementunit_timeoffplan

​genesys_workforce_patch_managementunit_timeoffrequest_user_integrationstatus

​genesys_workforce_patch_managementunit_user_timeoffrequest

​genesys_workforce_patch_managementunit_week_shifttrade

​genesys_workforce_patch_managementunit_workplan

​genesys_workforce_patch_managementunit_workplanrotation

​genesys_workforce_patch_timeoffrequest

​genesys_workforce_post_adherence_explanations

​genesys_workforce_post_adherence_explanations_query

​genesys_workforce_post_agent_adherence_explanations

​genesys_workforce_post_agent_adherence_explanations_query

​genesys_workforce_post_agents

​genesys_workforce_post_agents_me_adherence_historical_jobs

​genesys_workforce_post_agents_me_possibleworkshifts

​genesys_workforce_post_agentschedules_managementunits_mine

​genesys_workforce_post_agentschedules_mine

​genesys_workforce_post_managementunit_agents_workplans_query

​genesys_workforce_post_managementunit_agentschedules_search

​genesys_workforce_post_managementunit_historicaladherencequery

​genesys_workforce_post_managementunit_move

Tools

genesys_workforce_delete_managementunit

genesys_workforce_delete_managementunit_timeofflimit

genesys_workforce_delete_managementunit_timeoffplan

genesys_workforce_delete_managementunit_workplan

genesys_workforce_delete_managementunit_workplanrotation

genesys_workforce_get_adherence

genesys_workforce_get_adherence_explanation

genesys_workforce_get_adherence_explanations_job

genesys_workforce_get_adherence_historical_job

genesys_workforce_get_agent_adherence_explanation

genesys_workforce_get_agent_managementunit

genesys_workforce_get_agents_me_adherence_historical_job

genesys_workforce_get_agents_me_managementunit

genesys_workforce_get_managementunit

genesys_workforce_get_managementunit_adherence

genesys_workforce_get_managementunit_agent

genesys_workforce_get_managementunit_agent_shifttrades

genesys_workforce_get_managementunit_shifttrades_matched

genesys_workforce_get_managementunit_shifttrades_users

genesys_workforce_get_managementunit_timeofflimit

genesys_workforce_get_managementunit_timeofflimits

genesys_workforce_get_managementunit_timeoffplan

genesys_workforce_get_managementunit_timeoffplans

genesys_workforce_get_managementunit_user_timeoffrequest

genesys_workforce_get_managementunit_user_timeoffrequest_timeofflimits

genesys_workforce_get_managementunit_user_timeoffrequests

genesys_workforce_get_managementunit_users

genesys_workforce_get_managementunit_week_shifttrades

genesys_workforce_get_managementunit_workplan

genesys_workforce_get_managementunit_workplanrotation

genesys_workforce_get_managementunit_workplanrotations

genesys_workforce_get_managementunit_workplans

genesys_workforce_get_managementunits

genesys_workforce_get_notifications

genesys_workforce_get_shifttrades

genesys_workforce_get_team_adherence

genesys_workforce_get_timeoffbalance_job

genesys_workforce_get_timeoffrequest

genesys_workforce_get_timeoffrequest_waitlistpositions

genesys_workforce_get_timeoffrequests

genesys_workforce_get_workforcemanagement_adherence

genesys_workforce_get_workforcemanagement_managementunit

genesys_workforce_get_workforcemanagement_managementunit_adherence

genesys_workforce_get_workforcemanagement_managementunit_agent

genesys_workforce_get_workforcemanagement_managementunit_user_timeoffrequests

genesys_workforce_get_workforcemanagement_managementunit_users

genesys_workforce_get_workforcemanagement_managementunits

genesys_workforce_get_workforcemanagement_notifications

genesys_workforce_get_workforcemanagement_team_adherence

genesys_workforce_get_workforcemanagement_timeoffrequest

genesys_workforce_get_workforcemanagement_timeoffrequests

genesys_workforce_patch_agent_adherence_explanation

genesys_workforce_patch_managementunit

genesys_workforce_patch_managementunit_agents

genesys_workforce_patch_managementunit_timeofflimit

genesys_workforce_patch_managementunit_timeoffplan

genesys_workforce_patch_managementunit_timeoffrequest_user_integrationstatus

genesys_workforce_patch_managementunit_user_timeoffrequest

genesys_workforce_patch_managementunit_week_shifttrade

genesys_workforce_patch_managementunit_workplan

genesys_workforce_patch_managementunit_workplanrotation

genesys_workforce_patch_timeoffrequest

genesys_workforce_post_adherence_explanations

genesys_workforce_post_adherence_explanations_query

genesys_workforce_post_agent_adherence_explanations

genesys_workforce_post_agent_adherence_explanations_query

genesys_workforce_post_agents

genesys_workforce_post_agents_me_adherence_historical_jobs

genesys_workforce_post_agents_me_possibleworkshifts

genesys_workforce_post_agentschedules_managementunits_mine

genesys_workforce_post_agentschedules_mine

genesys_workforce_post_managementunit_agents_workplans_query

genesys_workforce_post_managementunit_agentschedules_search

genesys_workforce_post_managementunit_historicaladherencequery

genesys_workforce_post_managementunit_move

genesys_workforce_post_managementunit_timeofflimits

genesys_workforce_post_managementunit_timeofflimits_values_query

genesys_workforce_post_managementunit_timeoffplans

genesys_workforce_post_managementunit_timeoffrequests