---
title: Genesys Cloud API Integration on Truto
slug: genesyscloud
category: Voice
canonical: "https://truto.one/integrations/detail/genesyscloud/"
---

# Genesys Cloud API Integration on Truto



**Category:** Voice  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 3141 tools for Genesys Cloud that AI agents can call directly.

- **genesys_cloud_agentic_virtualagent_jobs_bulk_delete** — Start the deletion of a virtualAgent. (DELETE /api/v2/agentic/virtualagents/{virtualAgentId}/jobs) Requires permission agentic:virtualAgentJob:add. Required: virtual_agent_id.
- **get_single_genesys_cloud_agentic_virtualagent_job_by_id** — Get a virtualAgent job. (GET /api/v2/agentic/virtualagents/{virtualAgentId}/jobs/{jobId}) Requires permission agentic:virtualAgentJob:view. The id is the jobId. Required: id, virtual_agent_id.
- **create_a_genesys_cloud_agentic_virtualagent_version_job** — Start the publishing of a virtual agent version. (POST /api/v2/agentic/virtualagents/{virtualAgentId}/versions/{versionId}/jobs) Requires permission agentic:virtualAgentVersionJob:add. Required: virtual_agent_id, version_id, virtualAgentVersion.
- **get_single_genesys_cloud_agentic_virtualagent_version_job_by_id** — Get the status of the publishing job for this virtual agent version. (GET /api/v2/agentic/virtualagents/{virtualAgentId}/versions/{versionId}/jobs/{jobId}) Requires permission agentic:virtualAgentVersionJob:view. The id is the jobId. Required: id, virtual_agent_id, version_id.
- **create_a_genesys_cloud_agentic_virtualagent_version** — Create a virtual agent version. When validateOnly is true, the request is validated without creating a version. (POST /api/v2/agentic/virtualagents/{virtualAgentId}/versions) Requires permission agentic:virtualAgentVersion:add. Required: virtual_agent_id, definition.
- **get_single_genesys_cloud_agentic_virtualagent_version_by_id** — Get a virtual agent version. (GET /api/v2/agentic/virtualagents/{virtualAgentId}/versions/{versionId}) Requires permission agentic:virtualAgentVersion:view. The id is the versionId. Required: id, virtual_agent_id.
- **update_a_genesys_cloud_agentic_virtualagent_version_by_id** — Update a virtual agent version. When validateOnly is true, the update is validated without saving the version. (PATCH /api/v2/agentic/virtualagents/{virtualAgentId}/versions/{versionId}) Requires permission agentic:virtualAgentVersion:edit. The id is the versionId. Required: id, virtual_agent_id, definition.
- **create_a_genesys_cloud_agentic_virtualagent** — Create a virtual agent. (POST /api/v2/agentic/virtualagents) Requires permission agentic:virtualAgent:add. Required: name.
- **get_single_genesys_cloud_agentic_virtualagent_by_id** — Get virtual agent. (GET /api/v2/agentic/virtualagents/{virtualAgentId}) Requires permission agentic:virtualAgent:view. The id is the virtualAgentId. Required: id.
- **list_all_genesys_cloud_agentic_virtualagents** — Get all virtual agents. (GET /api/v2/agentic/virtualagents) Requires permission agentic:virtualAgent:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_agentic_virtualagent_by_id** — Update a virtual agent. (PATCH /api/v2/agentic/virtualagents/{virtualAgentId}) Requires permission agentic:virtualAgent:edit. The id is the virtualAgentId. Required: id, name.
- **genesys_cloud_alerting_alert_all_bulk_delete** — Delete all alerts for the user. (DELETE /api/v2/alerting/alerts/all) Requires permission alerting:alert:edit.
- **genesys_cloud_alerting_alert_all_bulk_partial_update** — Updates all alerts. (PATCH /api/v2/alerting/alerts/all) Requires permission alerting:alert:edit. Required: type.
- **genesys_cloud_alerting_alert_bulk_bulk_partial_update** — Bulk alert updates. (PATCH /api/v2/alerting/alerts/bulk) Requires permission alerting:alert:edit. Required: type, alertIds.
- **delete_a_genesys_cloud_alerting_alert_by_id** — Delete an alert. (DELETE /api/v2/alerting/alerts/{alertId}) Requires permission alerting:alert:delete. The id is the alertId. Required: id.
- **get_single_genesys_cloud_alerting_alert_by_id** — Get an alert. (GET /api/v2/alerting/alerts/{alertId}) Requires permission alerting:alert:view. The id is the alertId. Required: id.
- **genesys_cloud_alerting_alerts_partial_update** — Allows an entity to mute/snooze an alert, update the unread status of the alert, or close an alert. Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals. Closing an alert will mark it as closed. (PATCH /api/v2/alerting/alerts/{alertId}) Requires permission alerting:alert:edit. Required: alert_id, type.
- **genesys_cloud_alerting_alerts_search** — Gets a paged list of alerts. The max page size is 50. (POST /api/v2/alerting/alerts/query) Requires permission alerting:alert:view. Required: ruleType, queryType.
- **update_a_genesys_cloud_alerting_alert_by_id** — Update an alert read status. (PUT /api/v2/alerting/alerts/{alertId}) Requires permission alerting:alert:edit. The id is the alertId. Required: id, unread.
- **genesys_cloud_alerting_rule_bulk_bulk_partial_update** — Bulk update of notification lists. (PATCH /api/v2/alerting/rules/bulk) Requires permission alerting:rule:edit. Required: ruleIds.
- **create_a_genesys_cloud_alerting_rule_bulk_remove** — Bulk remove rules. (POST /api/v2/alerting/rules/bulk/remove) Requires permission alerting:rule:delete. Required: ruleIds.
- **create_a_genesys_cloud_alerting_rule** — Create a Rule. (POST /api/v2/alerting/rules) Requires permission alerting:rule:add. Required: name, type.
- **delete_a_genesys_cloud_alerting_rule_by_id** — Delete a rule. (DELETE /api/v2/alerting/rules/{ruleId}) Requires permission alerting:rule:delete. The id is the ruleId. Required: id.
- **get_single_genesys_cloud_alerting_rule_by_id** — Get a rule. (GET /api/v2/alerting/rules/{ruleId}) Requires permission alerting:rule:view. The id is the ruleId. Required: id.
- **genesys_cloud_alerting_rules_search** — Get a paged list of rules. The max size of the page is 50 items. (POST /api/v2/alerting/rules/query) Requires permission alerting:rule:view. Required: ruleType, queryType.
- **update_a_genesys_cloud_alerting_rule_by_id** — Update a rule. (PUT /api/v2/alerting/rules/{ruleId}) Requires permission alerting:rule:edit. The id is the ruleId. Required: id, name.
- **list_all_genesys_cloud_analytics_action_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/actions/aggregates/jobs/{jobId}/results) Requires any of permissions integrations:action:view, bridge:actions:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_action_aggregate_job** — Query for action aggregates asynchronously. (POST /api/v2/analytics/actions/aggregates/jobs) Requires any of permissions integrations:action:view, bridge:actions:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_action_aggregate_job_by_id** — Delete/cancel an async request for action aggregates. (DELETE /api/v2/analytics/actions/aggregates/jobs/{jobId}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_action_aggregate_job_by_id** — Get status for async query for action aggregates. (GET /api/v2/analytics/actions/aggregates/jobs/{jobId}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_action_aggregates_search** — Query for action aggregates. (POST /api/v2/analytics/actions/aggregates/query) Requires any of permissions integrations:action:view, bridge:actions:view. Required: interval, metrics.
- **genesys_cloud_analytics_agent_status_lookup** — Get an agent and their active sessions by user ID. (GET /api/v2/analytics/agents/{userId}/status) Requires permission analytics:agentState:view. Required: user_id.
- **genesys_cloud_analytics_agent_status_search** — Retrieve the top 50 agents matching the query filters. (POST /api/v2/analytics/agents/status/query) Requires permission analytics:agentState:view.
- **create_a_genesys_cloud_analytics_agent_status_count** — Count agents by different groupings. (POST /api/v2/analytics/agents/status/counts) Requires permission analytics:agentState:view.
- **list_all_analytics_agentcopilot_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}/results) Requires permission analytics:agentCopilotAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_agentcopilot_aggregate_job** — Query for agent copilot aggregates asynchronously. (POST /api/v2/analytics/agentcopilots/aggregates/jobs) Requires permission analytics:agentCopilotAggregate:view. Required: interval, metrics.
- **delete_analytics_agentcopilot_aggregate_job_by_id** — Delete/cancel an async request for agent copilot aggregates. (DELETE /api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}) Requires permission analytics:agentCopilotAggregate:view. The id is the jobId. Required: id.
- **get_analytics_agentcopilot_aggregate_job_by_id** — Get status for async query for agent copilot aggregates. (GET /api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}) Requires permission analytics:agentCopilotAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_agentcopilot_aggregates_search** — Query for agent copilot aggregates. (POST /api/v2/analytics/agentcopilots/aggregates/query) Requires permission analytics:agentCopilotAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_bot_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/bots/aggregates/jobs/{jobId}/results) Requires permission analytics:botAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_bot_aggregate_job** — Query for bot aggregates asynchronously. (POST /api/v2/analytics/bots/aggregates/jobs) Requires permission analytics:botAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_bot_aggregate_job_by_id** — Delete/cancel an async request for bot aggregates. (DELETE /api/v2/analytics/bots/aggregates/jobs/{jobId}) Requires permission analytics:botAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_bot_aggregate_job_by_id** — Get status for async query for bot aggregates. (GET /api/v2/analytics/bots/aggregates/jobs/{jobId}) Requires permission analytics:botAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_bot_aggregates_search** — Query for bot aggregates. (POST /api/v2/analytics/bots/aggregates/query) Requires permission analytics:botAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_botflow_division_reportingturns** — Get Reporting Turns (division aware). Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. (GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns) Requires permission analytics:botFlowDivisionAwareReportingTurn:view. Pages automatically: pass the returned next_cursor to get the next page. Required: bot_flow_id.
- **list_all_genesys_cloud_analytics_botflow_sessions** — Get Bot Flow Sessions. Returns the bot flow sessions in reverse chronological order from the date they were created. It is expected that the client will URL encode the request URI once only. (GET /api/v2/analytics/botflows/{botFlowId}/sessions) Requires permission analytics:botFlowSession:view. Pages automatically: pass the returned next_cursor to get the next page. Required: bot_flow_id.
- **list_all_analytics_casemanagement_aggregate_job_results** — Fetch a page of results for an async case management query. (GET /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results) Requires permission analytics:caseManagementAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_casemanagement_aggregate_job** — Query for case management aggregates asynchronously. (POST /api/v2/analytics/casemanagement/aggregates/jobs) Requires permission analytics:caseManagementAggregate:view. Required: interval, metrics.
- **delete_analytics_casemanagement_aggregate_job_by_id** — Delete/cancel an async request for case management aggregates. (DELETE /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}) Requires permission analytics:caseManagementAggregate:view. The id is the jobId. Required: id.
- **get_analytics_casemanagement_aggregate_job_by_id** — Get status for async query for case management aggregates. (GET /api/v2/analytics/casemanagement/aggregates/jobs/{jobId}) Requires permission analytics:caseManagementAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_casemanagement_aggregates_search** — Query for case management aggregates. (POST /api/v2/analytics/casemanagement/aggregates/query) Requires permission analytics:caseManagementAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_conversation_activity_search** — Query for conversation activity observations. (POST /api/v2/analytics/conversations/activity/query) Requires permission analytics:queueObservation:view. Required: metrics, groupBy.
- **list_all_analytics_conversation_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/conversations/aggregates/jobs/{jobId}/results) Requires permission analytics:conversationAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_conversation_aggregate_job** — Query for conversation aggregates asynchronously. (POST /api/v2/analytics/conversations/aggregates/jobs) Requires permission analytics:conversationAggregate:view. Required: interval, metrics.
- **delete_analytics_conversation_aggregate_job_by_id** — Delete/cancel an async request for conversation aggregates. (DELETE /api/v2/analytics/conversations/aggregates/jobs/{jobId}) Requires permission analytics:conversationAggregate:view. The id is the jobId. Required: id.
- **get_analytics_conversation_aggregate_job_by_id** — Get status for async query for conversation aggregates. (GET /api/v2/analytics/conversations/aggregates/jobs/{jobId}) Requires permission analytics:conversationAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_conversation_aggregates_search** — Query for conversation aggregates. (POST /api/v2/analytics/conversations/aggregates/query) Requires permission analytics:conversationAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_conversation_details** — Gets multiple conversations by id. (GET /api/v2/analytics/conversations/details) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view.
- **genesys_cloud_analytics_conversation_details_lookup** — Get a conversation by id. (GET /api/v2/analytics/conversations/{conversationId}/details) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view. Required: conversation_id.
- **genesys_cloud_analytics_conversation_details_search** — Query for conversation details. (POST /api/v2/analytics/conversations/details/query) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view, externalContacts:conversation:viewAll. Required: interval.
- **analytics_conversation_details_job_availability_lookup** — Lookup the datalake availability date and time. (GET /api/v2/analytics/conversations/details/jobs/availability) Requires permission analytics:conversationDetail:view.
- **genesys_cloud_analytics_conversation_details_job_results_lookup** — Fetch a page of results for an async details job. (GET /api/v2/analytics/conversations/details/jobs/{jobId}/results) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view. Required: job_id.
- **create_a_genesys_cloud_analytics_conversation_details_job** — Query for conversation details asynchronously. (POST /api/v2/analytics/conversations/details/jobs) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view, externalContacts:conversation:viewAll. Required: interval.
- **delete_a_genesys_cloud_analytics_conversation_details_job_by_id** — Delete/cancel an async details job. (DELETE /api/v2/analytics/conversations/details/jobs/{jobId}) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view. The id is the jobId. Required: id.
- **get_analytics_conversation_details_job_by_id** — Get status for async query for conversation details. (GET /api/v2/analytics/conversations/details/jobs/{jobId}) Requires any of permissions analytics:conversationDetail:view, analytics:agentConversationDetail:view. The id is the jobId. Required: id.
- **create_a_genesys_cloud_analytics_conversation_details_property** — Index conversation properties. (POST /api/v2/analytics/conversations/{conversationId}/details/properties) Requires permission analytics:conversationProperties:index. Required: conversation_id, sessionId, targetDate, properties.
- **list_all_genesys_cloud_analytics_copilot_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/copilots/aggregates/jobs/{jobId}/results) Requires permission analytics:copilotsAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_copilot_aggregate_job** — Query for copilot aggregates asynchronously. (POST /api/v2/analytics/copilots/aggregates/jobs) Requires permission analytics:copilotsAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_copilot_aggregate_job_by_id** — Delete/cancel an async request for copilot aggregates. (DELETE /api/v2/analytics/copilots/aggregates/jobs/{jobId}) Requires permission analytics:copilotsAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_copilot_aggregate_job_by_id** — Get status for async query for copilot aggregates. (GET /api/v2/analytics/copilots/aggregates/jobs/{jobId}) Requires permission analytics:copilotsAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_copilot_aggregates_search** — Query for copilot aggregates. (POST /api/v2/analytics/copilots/aggregates/query) Requires permission analytics:copilotsAggregate:view. Required: interval, metrics.
- **create_a_genesys_cloud_analytics_dataextraction_download_bulk** — Get download URLs for analytics data warehouse files. (POST /api/v2/analytics/dataextraction/downloads/bulk) Requires permission analytics:datawarehouse:view. Required: files.
- **genesys_cloud_analytics_dataextraction_download_metadata_lookup** — Get metadata on files available for extraction. (GET /api/v2/analytics/dataextraction/downloads/metadata) Requires permission analytics:datawarehouse:view.
- **get_single_genesys_cloud_analytics_dataextraction_download_by_id** — Get analytics data warehouse file download. (GET /api/v2/analytics/dataextraction/downloads/{downloadId}) Requires permission analytics:datawarehouse:view. The id is the downloadId. Required: id.
- **genesys_cloud_analytics_dataretention_settings_bulk_update** — Update analytics data retention setting. (PUT /api/v2/analytics/dataretention/settings) Requires permission analytics:dataRetention:edit. Required: retentionDays.
- **genesys_cloud_analytics_dataretention_settings_lookup** — Get analytics data retention setting. (GET /api/v2/analytics/dataretention/settings) Requires permission analytics:dataRetention:view.
- **list_all_analytics_evaluation_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results) Requires permission analytics:evaluationAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_evaluation_aggregate_job** — Query for evaluation aggregates asynchronously. (POST /api/v2/analytics/evaluations/aggregates/jobs) Requires permission analytics:evaluationAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_evaluation_aggregate_job_by_id** — Delete/cancel an async request for evaluation aggregates. (DELETE /api/v2/analytics/evaluations/aggregates/jobs/{jobId}) Requires permission analytics:evaluationAggregate:view. The id is the jobId. Required: id.
- **get_analytics_evaluation_aggregate_job_by_id** — Get status for async query for evaluation aggregates. (GET /api/v2/analytics/evaluations/aggregates/jobs/{jobId}) Requires permission analytics:evaluationAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_evaluation_aggregates_search** — Query for evaluation aggregates. (POST /api/v2/analytics/evaluations/aggregates/query) Requires permission analytics:evaluationAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_flow_activity_search** — Query for flow activity observations. (POST /api/v2/analytics/flows/activity/query) Requires permission analytics:flowObservation:view. Required: metrics, groupBy.
- **list_all_genesys_cloud_analytics_flow_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/flows/aggregates/jobs/{jobId}/results) Requires permission analytics:flowAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_flow_aggregate_job** — Query for flow aggregates asynchronously. (POST /api/v2/analytics/flows/aggregates/jobs) Requires permission analytics:flowAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_flow_aggregate_job_by_id** — Delete/cancel an async request for flow aggregates. (DELETE /api/v2/analytics/flows/aggregates/jobs/{jobId}) Requires permission analytics:flowAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_flow_aggregate_job_by_id** — Get status for async query for Flow aggregates. (GET /api/v2/analytics/flows/aggregates/jobs/{jobId}) Requires permission analytics:flowAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_flow_aggregates_search** — Query for flow aggregates. (POST /api/v2/analytics/flows/aggregates/query) Requires permission analytics:flowAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_flow_observations_search** — Query for flow observations. (POST /api/v2/analytics/flows/observations/query) Requires permission analytics:flowObservation:view. Required: filter, metrics.
- **list_all_analytics_flowexecution_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results) Requires permission analytics:flowExecutionAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_flowexecution_aggregate_job** — Query for flow execution aggregates asynchronously. (POST /api/v2/analytics/flowexecutions/aggregates/jobs) Requires permission analytics:flowExecutionAggregate:view. Required: interval, metrics.
- **delete_analytics_flowexecution_aggregate_job_by_id** — Delete/cancel an async request for flow execution aggregates. (DELETE /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}) Requires permission analytics:flowExecutionAggregate:view. The id is the jobId. Required: id.
- **get_analytics_flowexecution_aggregate_job_by_id** — Get status for async query for flow execution aggregates. (GET /api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}) Requires permission analytics:flowExecutionAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_flowexecution_aggregates_search** — Query for flow execution aggregates. (POST /api/v2/analytics/flowexecutions/aggregates/query) Requires permission analytics:flowExecutionAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_journey_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/journeys/aggregates/jobs/{jobId}/results) Requires permission analytics:journeyAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_journey_aggregate_job** — Query for journey aggregates asynchronously. (POST /api/v2/analytics/journeys/aggregates/jobs) Requires permission analytics:journeyAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_journey_aggregate_job_by_id** — Delete/cancel an async request for journey aggregates. (DELETE /api/v2/analytics/journeys/aggregates/jobs/{jobId}) Requires permission analytics:journeyAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_journey_aggregate_job_by_id** — Get status for async query for journey aggregates. (GET /api/v2/analytics/journeys/aggregates/jobs/{jobId}) Requires permission analytics:journeyAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_journey_aggregates_search** — Query for journey aggregates. (POST /api/v2/analytics/journeys/aggregates/query) Requires permission analytics:journeyAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_knowledge_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results) Requires permission analytics:knowledgeAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_knowledge_aggregate_job** — Query for knowledge aggregates asynchronously. (POST /api/v2/analytics/knowledge/aggregates/jobs) Requires permission analytics:knowledgeAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_knowledge_aggregate_job_by_id** — Delete/cancel an async request for knowledge aggregates. (DELETE /api/v2/analytics/knowledge/aggregates/jobs/{jobId}) Requires permission analytics:knowledgeAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_knowledge_aggregate_job_by_id** — Get status for async query for knowledge aggregates. (GET /api/v2/analytics/knowledge/aggregates/jobs/{jobId}) Requires permission analytics:knowledgeAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_knowledge_aggregates_search** — Query for knowledge aggregates. (POST /api/v2/analytics/knowledge/aggregates/query) Requires permission analytics:knowledgeAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_queue_observations_search** — Query for queue observations. (POST /api/v2/analytics/queues/observations/query) Requires permission analytics:queueObservation:view. Required: filter, metrics.
- **genesys_cloud_analytics_ratelimit_aggregates_search** — Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate. The 'max' property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled). (POST /api/v2/analytics/ratelimits/aggregates/query) Requires permission analytics:rateLimitAggregate:view. Required: interval, metrics.
- **create_analytics_reporting_dashboard_user_bulk_remove** — Bulk soft delete dashboards owned by other user(s). (POST /api/v2/analytics/reporting/dashboards/users/bulk/remove) Requires any of permissions analytics:dashboardConfigurations:deleteActive, analytics:dashboardConfigurations:deleteInactive.
- **get_analytics_reporting_dashboard_user_by_id** — Get dashboards summary for a user. (GET /api/v2/analytics/reporting/dashboards/users/{userId}) Requires permission analytics:dashboardConfigurations:view. The id is the userId. Required: id.
- **list_all_genesys_cloud_analytics_reporting_dashboard_users** — Get dashboards summary for users in a org. (GET /api/v2/analytics/reporting/dashboards/users) Requires permission analytics:dashboardConfigurations:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_analytics_reporting_export_metadata** — Get all export metadata. (GET /api/v2/analytics/reporting/exports/metadata) Requires permission analytics:dataExport:view.
- **create_a_genesys_cloud_analytics_reporting_export** — Generate a view export request. This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead. (POST /api/v2/analytics/reporting/exports) Requires permission analytics:dataExport:add. Required: name, timeZone, exportFormat, interval, period, viewType, filter, locale.
- **list_all_genesys_cloud_analytics_reporting_exports** — Get all view export requests for a user. (GET /api/v2/analytics/reporting/exports) Requires permission analytics:dataExport:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_analytics_reporting_settings_bulk_partial_update** — Patch AnalyticsReportingSettings values for an organization. (PATCH /api/v2/analytics/reporting/settings) Requires permission analytics:reportingSettings:edit.
- **genesys_cloud_analytics_reporting_settings_lookup** — Get AnalyticsReportingSettings for an organization. (GET /api/v2/analytics/reporting/settings)
- **create_analytics_reporting_settings_dashboard_bulk_remove** — Bulk soft delete dashboard configurations. (POST /api/v2/analytics/reporting/settings/dashboards/bulk/remove) Requires permission analytics:dashboardConfigurations:edit. Required: dashboardConfigurationIds.
- **list_all_analytics_reporting_settings_dashboard_query** — Get list of dashboard configurations. (GET /api/v2/analytics/reporting/settings/dashboards/query) Requires permission analytics:dashboardConfigurations:view. Pages automatically with pageNumber/pageSize. Required: dashboardType, dashboardAccessFilter.
- **genesys_cloud_analytics_reporting_settings_dashboards_search** — Query dashboard configurations. (POST /api/v2/analytics/reporting/settings/dashboards/query) Requires permission analytics:dashboardConfigurations:view. Required: dashboardConfigurationIds.
- **list_all_analytics_reporting_settings_user_dashboards** — Get list of dashboards for an user. (GET /api/v2/analytics/reporting/settings/users/{userId}/dashboards) Requires permission analytics:dashboardConfigurations:viewPrivate. Pages automatically with pageNumber/pageSize. Required: user_id.
- **list_all_analytics_resolution_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results) Requires permission analytics:resolutionAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_resolution_aggregate_job** — Query for resolution aggregates asynchronously. (POST /api/v2/analytics/resolutions/aggregates/jobs) Requires permission analytics:resolutionAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_resolution_aggregate_job_by_id** — Delete/cancel an async request for resolution aggregates. (DELETE /api/v2/analytics/resolutions/aggregates/jobs/{jobId}) Requires permission analytics:resolutionAggregate:view. The id is the jobId. Required: id.
- **get_analytics_resolution_aggregate_job_by_id** — Get status for async query for resolution aggregates. (GET /api/v2/analytics/resolutions/aggregates/jobs/{jobId}) Requires permission analytics:resolutionAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_resolution_aggregates_search** — Query for resolution aggregates. (POST /api/v2/analytics/resolutions/aggregates/query) Requires permission analytics:resolutionAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_routing_activity_search** — Query for user activity observations. (POST /api/v2/analytics/routing/activity/query) Requires permission analytics:queueObservation:view. Required: metrics, groupBy.
- **list_all_genesys_cloud_analytics_summary_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/summaries/aggregates/jobs/{jobId}/results) Requires permission analytics:summaryAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_summary_aggregate_job** — Query for summary aggregates asynchronously. (POST /api/v2/analytics/summaries/aggregates/jobs) Requires permission analytics:summaryAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_summary_aggregate_job_by_id** — Delete/cancel an async request for summary aggregates. (DELETE /api/v2/analytics/summaries/aggregates/jobs/{jobId}) Requires permission analytics:summaryAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_summary_aggregate_job_by_id** — Get status for async query for summary aggregates. (GET /api/v2/analytics/summaries/aggregates/jobs/{jobId}) Requires permission analytics:summaryAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_summary_aggregates_search** — Query for summary aggregates. (POST /api/v2/analytics/summaries/aggregates/query) Requires permission analytics:summaryAggregate:view. Required: interval, metrics.
- **list_all_genesys_cloud_analytics_survey_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/surveys/aggregates/jobs/{jobId}/results) Requires permission analytics:surveyAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_survey_aggregate_job** — Query for survey aggregates asynchronously. (POST /api/v2/analytics/surveys/aggregates/jobs) Requires permission analytics:surveyAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_survey_aggregate_job_by_id** — Delete/cancel an async request for survey aggregates. (DELETE /api/v2/analytics/surveys/aggregates/jobs/{jobId}) Requires permission analytics:surveyAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_survey_aggregate_job_by_id** — Get status for async query for survey aggregates. (GET /api/v2/analytics/surveys/aggregates/jobs/{jobId}) Requires permission analytics:surveyAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_survey_aggregates_search** — Query for survey aggregates. (POST /api/v2/analytics/surveys/aggregates/query) Requires permission analytics:surveyAggregate:view. Required: interval, metrics.
- **list_all_analytics_taskmanagement_aggregate_job_results** — Fetch a page of results for an async task management query. (GET /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results) Requires permission analytics:taskManagementAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_taskmanagement_aggregate_job** — Query for task management aggregates asynchronously. (POST /api/v2/analytics/taskmanagement/aggregates/jobs) Requires permission analytics:taskManagementAggregate:view. Required: interval, metrics.
- **delete_analytics_taskmanagement_aggregate_job_by_id** — Delete/cancel an async request for task management aggregates. (DELETE /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}) Requires permission analytics:taskManagementAggregate:view. The id is the jobId. Required: id.
- **get_analytics_taskmanagement_aggregate_job_by_id** — Get status for async query for task management aggregates. (GET /api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}) Requires permission analytics:taskManagementAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_taskmanagement_aggregates_search** — Query for task management aggregates. (POST /api/v2/analytics/taskmanagement/aggregates/query) Requires permission analytics:taskManagementAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_taskmanagement_metrics_search** — Query for task management observations. (POST /api/v2/analytics/taskmanagement/metrics/query) Requires permission analytics:taskManagementObservation:view. Required: groupBy, metrics, filter.
- **genesys_cloud_analytics_team_activity_search** — Query for team activity observations. (POST /api/v2/analytics/teams/activity/query) Requires permission analytics:teamObservation:view. Required: metrics, groupBy.
- **list_all_analytics_transcript_aggregate_job_results** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results) Requires permission analytics:speechAndTextAnalyticsAggregates:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_analytics_transcript_aggregate_job** — Query for transcript aggregates asynchronously. (POST /api/v2/analytics/transcripts/aggregates/jobs) Requires permission analytics:speechAndTextAnalyticsAggregates:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_transcript_aggregate_job_by_id** — Delete/cancel an async request for transcript aggregates. (DELETE /api/v2/analytics/transcripts/aggregates/jobs/{jobId}) Requires permission analytics:speechAndTextAnalyticsAggregates:view. The id is the jobId. Required: id.
- **get_analytics_transcript_aggregate_job_by_id** — Get status for async query for transcript aggregates. (GET /api/v2/analytics/transcripts/aggregates/jobs/{jobId}) Requires permission analytics:speechAndTextAnalyticsAggregates:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_transcript_aggregates_search** — Query for transcript aggregates. (POST /api/v2/analytics/transcripts/aggregates/query) Requires permission analytics:speechAndTextAnalyticsAggregates:view. Required: interval, metrics.
- **genesys_cloud_analytics_user_activity_search** — Query for user activity observations. (POST /api/v2/analytics/users/activity/query) Requires permission analytics:userObservation:view. Required: metrics, groupBy.
- **genesys_cloud_analytics_user_aggregate_job_results_lookup** — Fetch a page of results for an async aggregates query. (GET /api/v2/analytics/users/aggregates/jobs/{jobId}/results) Requires permission analytics:userAggregate:view. Required: job_id.
- **create_a_genesys_cloud_analytics_user_aggregate_job** — Query for user aggregates asynchronously. (POST /api/v2/analytics/users/aggregates/jobs) Requires permission analytics:userAggregate:view. Required: interval, metrics.
- **delete_a_genesys_cloud_analytics_user_aggregate_job_by_id** — Delete/cancel an async request for user aggregates. (DELETE /api/v2/analytics/users/aggregates/jobs/{jobId}) Requires permission analytics:userAggregate:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_user_aggregate_job_by_id** — Get status for async query for user aggregates. (GET /api/v2/analytics/users/aggregates/jobs/{jobId}) Requires permission analytics:userAggregate:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_user_aggregates_search** — Query for user aggregates. (POST /api/v2/analytics/users/aggregates/query) Requires permission analytics:userAggregate:view. Required: interval, metrics.
- **genesys_cloud_analytics_user_details_search** — Query for user details. (POST /api/v2/analytics/users/details/query) Requires permission analytics:userDetail:view. Required: interval.
- **genesys_cloud_analytics_user_details_job_availability_lookup** — Lookup the datalake availability date and time. (GET /api/v2/analytics/users/details/jobs/availability) Requires permission analytics:userDetail:view.
- **genesys_cloud_analytics_user_details_job_results_lookup** — Fetch a page of results for an async query. (GET /api/v2/analytics/users/details/jobs/{jobId}/results) Requires permission analytics:userDetail:view. Required: job_id.
- **create_a_genesys_cloud_analytics_user_details_job** — Query for user details asynchronously. (POST /api/v2/analytics/users/details/jobs) Requires permission analytics:userDetail:view. Required: interval.
- **delete_a_genesys_cloud_analytics_user_details_job_by_id** — Delete/cancel an async request. (DELETE /api/v2/analytics/users/details/jobs/{jobId}) Requires permission analytics:userDetail:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_analytics_user_details_job_by_id** — Get status for async query for user details. (GET /api/v2/analytics/users/details/jobs/{jobId}) Requires permission analytics:userDetail:view. The id is the jobId. Required: id.
- **genesys_cloud_analytics_user_observations_search** — Query for user observations. (POST /api/v2/analytics/users/observations/query) Requires permission analytics:userObservation:view. Required: filter, metrics.
- **list_all_genesys_cloud_architect_dependencytracking** — Get Dependency Tracking objects that have a given display name. (GET /api/v2/architect/dependencytracking) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize. Required: name.
- **create_a_genesys_cloud_architect_dependencytracking_build** — Rebuild Dependency Tracking data for an organization. Asynchronous. Notification topic: v2.architect.dependencytracking.build. (POST /api/v2/architect/dependencytracking/build) Requires permission architect:dependencyTracking:rebuild.
- **genesys_cloud_architect_dependencytracking_build_lookup** — Get Dependency Tracking build status for an organization. (GET /api/v2/architect/dependencytracking/build) Requires permission architect:dependencyTracking:view.
- **list_all_architect_dependencytracking_consumedresources** — Get resources that are consumed by a given Dependency Tracking object. (GET /api/v2/architect/dependencytracking/consumedresources) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize. Required: id, version, objectType.
- **list_all_architect_dependencytracking_consumingresources** — Get resources that consume a given Dependency Tracking object. (GET /api/v2/architect/dependencytracking/consumingresources) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize. Required: id, objectType.
- **list_all_architect_dependencytracking_deletedresourceconsumers** — Get Dependency Tracking objects that consume deleted resources. (GET /api/v2/architect/dependencytracking/deletedresourceconsumers) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_architect_dependencytracking_object_lookup** — Get a Dependency Tracking object. (GET /api/v2/architect/dependencytracking/object) Requires permission architect:dependencyTracking:view. Required: id.
- **get_single_genesys_cloud_architect_dependencytracking_type_by_id** — Get a Dependency Tracking type. (GET /api/v2/architect/dependencytracking/types/{typeId}) Requires permission architect:dependencyTracking:view. The id is the typeId. Required: id.
- **list_all_genesys_cloud_architect_dependencytracking_types** — Get Dependency Tracking types. (GET /api/v2/architect/dependencytracking/types) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize.
- **list_all_architect_dependencytracking_updatedresourceconsumers** — Get Dependency Tracking objects that depend on updated resources. (GET /api/v2/architect/dependencytracking/updatedresourceconsumers) Requires permission architect:dependencyTracking:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_architect_emergencygroup_divisionviews** — Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch emergency groups that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/architect/emergencygroups/divisionviews) Requires permission routing:emergencyGroup:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_architect_emergencygroup** — Creates a new emergency group. (POST /api/v2/architect/emergencygroups) Requires permission routing:emergencyGroup:add. Required: name.
- **delete_a_genesys_cloud_architect_emergencygroup_by_id** — Deletes a emergency group by ID. (DELETE /api/v2/architect/emergencygroups/{emergencyGroupId}) Requires permission routing:emergencyGroup:delete. The id is the emergencyGroupId. Required: id.
- **get_single_genesys_cloud_architect_emergencygroup_by_id** — Gets a emergency group by ID. (GET /api/v2/architect/emergencygroups/{emergencyGroupId}) Requires permission routing:emergencyGroup:view. The id is the emergencyGroupId. Required: id.
- **list_all_genesys_cloud_architect_emergencygroups** — Get a list of emergency groups. (GET /api/v2/architect/emergencygroups) Requires permission routing:emergencyGroup:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_emergencygroup_by_id** — Updates a emergency group by ID. (PUT /api/v2/architect/emergencygroups/{emergencyGroupId}) Requires permission routing:emergencyGroup:edit. The id is the emergencyGroupId. Required: id, name.
- **genesys_cloud_architect_grammar_language_file_dtmf_bulk_delete** — Clear the DTMF mode file for the grammar language if there is one. (DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf) Requires permission architect:grammar:edit. Required: grammar_id, language_code.
- **create_a_genesys_cloud_architect_grammar_language_file_dtmf** — Creates a presigned URL for uploading a grammar DTMF mode file. (POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf) Requires permission architect:grammar:edit. Required: grammar_id, language_code.
- **genesys_cloud_architect_grammar_language_file_voice_bulk_delete** — Clear the voice mode file for the grammar language if there is one. (DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice) Requires permission architect:grammar:edit. Required: grammar_id, language_code.
- **create_a_genesys_cloud_architect_grammar_language_file_voice** — Creates a presigned URL for uploading a grammar voice mode file. (POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice) Requires permission architect:grammar:edit. Required: grammar_id, language_code.
- **create_a_genesys_cloud_architect_grammar_language** — Create a new language for a given grammar. (POST /api/v2/architect/grammars/{grammarId}/languages) Requires permission architect:grammar:edit. Required: grammar_id.
- **delete_a_genesys_cloud_architect_grammar_language_by_id** — Delete specified grammar language. (DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}) Requires permission architect:grammar:edit. The id is the languageCode. Required: id, grammar_id.
- **get_single_genesys_cloud_architect_grammar_language_by_id** — Get a grammar language. (GET /api/v2/architect/grammars/{grammarId}/languages/{languageCode}) Requires permission architect:grammar:view. The id is the languageCode. Required: id, grammar_id.
- **update_a_genesys_cloud_architect_grammar_language_by_id** — Updates a grammar language. (PATCH /api/v2/architect/grammars/{grammarId}/languages/{languageCode}) Requires permission architect:grammar:edit. The id is the languageCode. Required: id, grammar_id.
- **create_a_genesys_cloud_architect_grammar** — Create a new grammar. (POST /api/v2/architect/grammars) Requires permission architect:grammar:add.
- **delete_a_genesys_cloud_architect_grammar_by_id** — Delete a grammar. (DELETE /api/v2/architect/grammars/{grammarId}) Requires permission architect:grammar:delete. The id is the grammarId. Required: id.
- **get_single_genesys_cloud_architect_grammar_by_id** — Get a grammar. Returns a specified grammar. (GET /api/v2/architect/grammars/{grammarId}) Requires permission architect:grammar:view. The id is the grammarId. Required: id.
- **list_all_genesys_cloud_architect_grammars** — Get a pageable list of grammars, filtered by query parameters. Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated. (GET /api/v2/architect/grammars) Requires permission architect:grammar:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_grammar_by_id** — Updates a grammar. (PATCH /api/v2/architect/grammars/{grammarId}) Requires permission architect:grammar:edit. The id is the grammarId. Required: id.
- **list_all_genesys_cloud_architect_ivr_divisionviews** — Get a pageable list of basic ivr configuration information objects filterable by query parameters. (GET /api/v2/architect/ivrs/divisionviews) Requires permission routing:callRoute:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_architect_ivr_identityresolution_bulk_update** — Update an IVR IdentityResolutionConfig. (PUT /api/v2/architect/ivrs/{ivrId}/identityresolution) Requires permissions routing:callRoute:edit, routing:identityResolutionIvr:edit. Required: ivr_id, resolveIdentities.
- **genesys_cloud_architect_ivr_identityresolution_lookup** — Get an IVR IdentityResolutionConfig. (GET /api/v2/architect/ivrs/{ivrId}/identityresolution) Requires permissions routing:callRoute:view, routing:identityResolutionIvr:view. Required: ivr_id.
- **create_a_genesys_cloud_architect_ivr** — Create IVR config. (POST /api/v2/architect/ivrs) Requires permission routing:callRoute:add. Required: name.
- **delete_a_genesys_cloud_architect_ivr_by_id** — Delete an IVR Config. (DELETE /api/v2/architect/ivrs/{ivrId}) Requires permission routing:callRoute:delete. The id is the ivrId. Required: id.
- **get_single_genesys_cloud_architect_ivr_by_id** — Get an IVR config. (GET /api/v2/architect/ivrs/{ivrId}) Requires permission routing:callRoute:view. The id is the ivrId. Required: id.
- **list_all_genesys_cloud_architect_ivrs** — Get IVR configs. (GET /api/v2/architect/ivrs) Requires permission routing:callRoute:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_ivr_by_id** — Update an IVR Config. (PUT /api/v2/architect/ivrs/{ivrId}) Requires permission routing:callRoute:edit. The id is the ivrId. Required: id, name.
- **create_a_genesys_cloud_architect_prompt_history** — Generate prompt history. Asynchronous. Notification topic: v2.architect.prompts.{promptId}. (POST /api/v2/architect/prompts/{promptId}/history) Requires permission architect:userPrompt:view. Required: prompt_id.
- **get_single_genesys_cloud_architect_prompt_history_by_id** — Get generated prompt history. (GET /api/v2/architect/prompts/{promptId}/history/{historyId}) Requires permission architect:userPrompt:view. The id is the historyId. Required: id, prompt_id.
- **genesys_cloud_architect_prompt_resource_audio_bulk_delete** — Delete specified user prompt resource audio. (DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio) Requires permission architect:userPrompt:edit. Required: prompt_id, language_code.
- **create_a_genesys_cloud_architect_prompt_resource** — Create a new user prompt resource. (POST /api/v2/architect/prompts/{promptId}/resources) Requires permission architect:userPrompt:edit. Required: prompt_id, language.
- **delete_a_genesys_cloud_architect_prompt_resource_by_id** — Delete specified user prompt resource. (DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}) Requires permission architect:userPrompt:edit. The id is the languageCode. Required: id, prompt_id.
- **get_single_genesys_cloud_architect_prompt_resource_by_id** — Get specified user prompt resource. (GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}) Requires permission architect:userPrompt:view. The id is the languageCode. Required: id, prompt_id.
- **list_all_genesys_cloud_architect_prompt_resources** — Get a pageable list of user prompt resources. The returned list is pageable, and query parameters can be used for filtering. (GET /api/v2/architect/prompts/{promptId}/resources) Requires permission architect:userPrompt:view. Pages automatically with pageNumber/pageSize. Required: prompt_id.
- **update_a_genesys_cloud_architect_prompt_resource_by_id** — Update specified user prompt resource. (PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}) Requires permission architect:userPrompt:edit. The id is the languageCode. Required: id, prompt_id.
- **genesys_cloud_architect_prompts_bulk_delete** — Batch-delete a list of prompts. Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}. (DELETE /api/v2/architect/prompts) Requires permission architect:userPrompt:delete. Required: id.
- **create_a_genesys_cloud_architect_prompt** — Create a new user prompt. (POST /api/v2/architect/prompts) Requires permission architect:userPrompt:add. Required: name.
- **delete_a_genesys_cloud_architect_prompt_by_id** — Delete specified user prompt. (DELETE /api/v2/architect/prompts/{promptId}) Requires permission architect:userPrompt:delete. The id is the promptId. Required: id.
- **get_single_genesys_cloud_architect_prompt_by_id** — Get specified user prompt. (GET /api/v2/architect/prompts/{promptId}) Requires permission architect:userPrompt:view. The id is the promptId. Required: id.
- **list_all_genesys_cloud_architect_prompts** — Get a pageable list of user prompts. The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated. (GET /api/v2/architect/prompts) Requires permission architect:userPrompt:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_prompt_by_id** — Update specified user prompt. (PUT /api/v2/architect/prompts/{promptId}) Requires permission architect:userPrompt:edit. The id is the promptId. Required: id, name.
- **list_all_genesys_cloud_architect_schedule_divisionviews** — Get a pageable list of basic schedule configuration information objects filterable by query parameters. (GET /api/v2/architect/schedules/divisionviews) Requires permission routing:schedule:search. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_architect_schedulegroup_divisionviews** — Get a pageable list of basic schedule group configuration information objects filterable by query parameters. (GET /api/v2/architect/schedulegroups/divisionviews) Requires permission routing:scheduleGroup:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_architect_schedulegroup** — Creates a new schedule group. (POST /api/v2/architect/schedulegroups) Requires permission routing:scheduleGroup:add. Required: name.
- **delete_a_genesys_cloud_architect_schedulegroup_by_id** — Deletes a schedule group by ID. (DELETE /api/v2/architect/schedulegroups/{scheduleGroupId}) Requires permission routing:scheduleGroup:delete. The id is the scheduleGroupId. Required: id.
- **get_single_genesys_cloud_architect_schedulegroup_by_id** — Gets a schedule group by ID. (GET /api/v2/architect/schedulegroups/{scheduleGroupId}) Requires permission routing:scheduleGroup:view. The id is the scheduleGroupId. Required: id.
- **list_all_genesys_cloud_architect_schedulegroups** — Get a list of schedule groups. (GET /api/v2/architect/schedulegroups) Requires permission routing:scheduleGroup:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_schedulegroup_by_id** — Updates a schedule group by ID. (PUT /api/v2/architect/schedulegroups/{scheduleGroupId}) Requires permission routing:scheduleGroup:edit. The id is the scheduleGroupId. Required: id, name.
- **create_a_genesys_cloud_architect_schedule** — Create a new schedule. (POST /api/v2/architect/schedules) Requires permission routing:schedule:add. Required: name, start, end.
- **delete_a_genesys_cloud_architect_schedule_by_id** — Delete a schedule by id. (DELETE /api/v2/architect/schedules/{scheduleId}) Requires permission routing:schedule:delete. The id is the scheduleId. Required: id.
- **get_single_genesys_cloud_architect_schedule_by_id** — Get a schedule by ID. (GET /api/v2/architect/schedules/{scheduleId}) Requires permission routing:schedule:view. The id is the scheduleId. Required: id.
- **list_all_genesys_cloud_architect_schedules** — Get a list of schedules. (GET /api/v2/architect/schedules) Requires permission routing:schedule:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_architect_schedule_by_id** — Update schedule by ID. (PUT /api/v2/architect/schedules/{scheduleId}) Requires permission routing:schedule:edit. The id is the scheduleId. Required: id, name, start, end.
- **create_a_genesys_cloud_architect_systemprompt_history** — Generate system prompt history. Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}. (POST /api/v2/architect/systemprompts/{promptId}/history) Requires permission architect:systemPrompt:view. Required: prompt_id.
- **get_single_genesys_cloud_architect_systemprompt_history_by_id** — Get generated prompt history. (GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}) Requires permission architect:systemPrompt:view. The id is the historyId. Required: id, prompt_id.
- **create_a_genesys_cloud_architect_systemprompt_resource** — Create system prompt resource override. (POST /api/v2/architect/systemprompts/{promptId}/resources) Requires permission architect:systemPrompt:edit. Required: prompt_id, language.
- **delete_a_genesys_cloud_architect_systemprompt_resource_by_id** — Delete a system prompt resource override. (DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}) Requires permission architect:systemPrompt:edit. The id is the languageCode. Required: id, prompt_id.
- **get_single_genesys_cloud_architect_systemprompt_resource_by_id** — Get a system prompt resource. (GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}) Requires permission architect:systemPrompt:view. The id is the languageCode. Required: id, prompt_id.
- **list_all_genesys_cloud_architect_systemprompt_resources** — Get system prompt resources. (GET /api/v2/architect/systemprompts/{promptId}/resources) Requires permission architect:systemPrompt:view. Pages automatically with pageNumber/pageSize. Required: prompt_id.
- **update_a_genesys_cloud_architect_systemprompt_resource_by_id** — Updates a system prompt resource override. (PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}) Requires permission architect:systemPrompt:edit. The id is the languageCode. Required: id, prompt_id, language.
- **get_single_genesys_cloud_architect_systemprompt_by_id** — Get a system prompt. (GET /api/v2/architect/systemprompts/{promptId}) Requires permission architect:systemPrompt:view. The id is the promptId. Required: id.
- **list_all_genesys_cloud_architect_systemprompts** — Get System Prompts. (GET /api/v2/architect/systemprompts) Requires permission architect:systemPrompt:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_assistant_agentchecklist_languages** — Get the list of supported languages. (GET /api/v2/assistants/agentchecklists/languages) Requires permission assistants:agentchecklist:view.
- **create_a_genesys_cloud_assistant_agentchecklist** — Create an agent checklist. (POST /api/v2/assistants/agentchecklists) Requires permission assistants:agentchecklist:add. Required: name, language, checklistItems.
- **delete_a_genesys_cloud_assistant_agentchecklist_by_id** — Delete an agent checklist. (DELETE /api/v2/assistants/agentchecklists/{agentChecklistId}) Requires permission assistants:agentchecklist:delete. The id is the agentChecklistId. Required: id.
- **get_single_genesys_cloud_assistant_agentchecklist_by_id** — Get an agent checklist. (GET /api/v2/assistants/agentchecklists/{agentChecklistId}) Requires permission assistants:agentchecklist:view. The id is the agentChecklistId. Required: id.
- **list_all_genesys_cloud_assistant_agentchecklists** — Get the list of agent checklists. (GET /api/v2/assistants/agentchecklists) Requires permission assistants:agentchecklist:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_assistant_agentchecklist_by_id** — Update an agent checklist. (PUT /api/v2/assistants/agentchecklists/{agentChecklistId}) Requires permission assistants:agentchecklist:edit. The id is the agentChecklistId. Required: id, name, language, checklistItems.
- **genesys_cloud_assistant_copilot_bulk_update** — Update agent copilot configuration. (PUT /api/v2/assistants/{assistantId}/copilot) Requires permission assistants:copilot:edit. Required: assistant_id, liveOnQueue, defaultLanguage.
- **genesys_cloud_assistant_copilot_lookup** — Get copilot configuration of an assistant. (GET /api/v2/assistants/{assistantId}/copilot) Requires permission assistants:copilot:view. Required: assistant_id.
- **list_all_genesys_cloud_assistant_copilot_featuresupport** — Get information about the support of features for all the languages or only for a certain language. (GET /api/v2/assistants/copilot/featuresupport) Requires any of permissions assistants:copilot:view, assistants:copilotFeatureSupport:view.
- **create_a_genesys_cloud_assistant_queue_user_bulk_add** — Bulk add users to assistant-queue (requires manual assignment mode). (POST /api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add) Requires permission assistants:queueUserAssignment:add. Required: assistant_id, queue_id, entities.
- **create_a_genesys_cloud_assistant_queue_user_bulk_remove** — Bulk remove users from assistant-queue (requires manual assignment mode). (POST /api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove) Requires permission assistants:queueUserAssignment:delete. Required: assistant_id, queue_id, entities.
- **create_a_genesys_cloud_assistant_queue_user_job** — Start a new job to assistant-queue. (POST /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs) Requires permission assistants:queueUserJob:add. Required: assistant_id, queue_id, action.
- **get_single_genesys_cloud_assistant_queue_user_job_by_id** — Get job details. (GET /api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs/{jobId}) Requires permission assistants:queueUserJob:view. The id is the jobId. Required: id, assistant_id, queue_id.
- **genesys_cloud_assistant_queue_users_search** — Query for users in the assistant-queue (requires manual assignment mode). (POST /api/v2/assistants/{assistantId}/queues/{queueId}/users/query) Requires permission assistants:queueUserAssignment:view. Required: assistant_id, queue_id, entities.
- **genesys_cloud_assistant_queues_bulk_delete** — Disassociate the queues from an assistant for the given assistant ID and queue IDs. (DELETE /api/v2/assistants/{assistantId}/queues) Requires permission assistants:queue:delete. Required: assistant_id.
- **genesys_cloud_assistant_queues_bulk_partial_update** — Update Queues for an Assistant. (PATCH /api/v2/assistants/{assistantId}/queues) Requires permission assistants:queue:edit. Required: assistant_id.
- **delete_a_genesys_cloud_assistant_queue_by_id** — Disassociate a queue from an assistant. (DELETE /api/v2/assistants/{assistantId}/queues/{queueId}) Requires permission assistants:queue:delete. The id is the queueId. Required: id, assistant_id.
- **get_single_genesys_cloud_assistant_queue_by_id** — Get queue Information for an assistant. (GET /api/v2/assistants/{assistantId}/queues/{queueId}) Requires permission assistants:queue:view. The id is the queueId. Required: id, assistant_id.
- **list_all_genesys_cloud_assistant_queues** — Get all queues assigned to any assistant. (GET /api/v2/assistants/queues) Requires permission assistants:queue:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_assistant_queue_by_id** — Create a queue assistant association. (PUT /api/v2/assistants/{assistantId}/queues/{queueId}) Requires permission assistants:queue:edit. The id is the queueId. Required: id, assistant_id, mediaTypes.
- **list_all_genesys_cloud_assistant_queues_by_assistant** — Get all the queues associated with an assistant. (GET /api/v2/assistants/{assistantId}/queues) Requires permission assistants:queue:view. Pages automatically: pass the returned next_cursor to get the next page. Required: assistant_id.
- **create_a_genesys_cloud_assistant_variation** — Create assistant copilot variation. (POST /api/v2/assistants/{assistantId}/variations) Requires permission assistants:copilot:edit. Required: assistant_id, name, transcriptionConfig, copilot.
- **delete_a_genesys_cloud_assistant_variation_by_id** — Delete assistant copilot variation by id. (DELETE /api/v2/assistants/{assistantId}/variations/{variationId}) Requires permission assistants:copilot:edit. The id is the variationId. Required: id, assistant_id.
- **get_single_genesys_cloud_assistant_variation_by_id** — Get assistant copilot variation by id. (GET /api/v2/assistants/{assistantId}/variations/{variationId}) Requires permission assistants:copilot:view. The id is the variationId. Required: id, assistant_id.
- **list_all_genesys_cloud_assistant_variations** — Get variations of an assistant copilot. (GET /api/v2/assistants/{assistantId}/variations) Requires permission assistants:copilot:view. Required: assistant_id.
- **update_a_genesys_cloud_assistant_variation_by_id** — Update assistant copilot variation by id. (PUT /api/v2/assistants/{assistantId}/variations/{variationId}) Requires permission assistants:copilot:edit. The id is the variationId. Required: id, assistant_id, name, transcriptionConfig, copilot.
- **create_a_genesys_cloud_assistant** — Create an Assistant. (POST /api/v2/assistants) Requires permission assistants:assistant:add. Required: name, transcriptionConfig.
- **delete_a_genesys_cloud_assistant_by_id** — Delete an assistant. (DELETE /api/v2/assistants/{assistantId}) Requires permission assistants:assistant:delete. The id is the assistantId. Required: id.
- **get_single_genesys_cloud_assistant_by_id** — Get an assistant. (GET /api/v2/assistants/{assistantId}) Requires permission assistants:assistant:view. The id is the assistantId. Required: id.
- **list_all_genesys_cloud_assistants** — Get all assistants. (GET /api/v2/assistants) Requires permission assistants:assistant:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_assistant_by_id** — Update an assistant. (PATCH /api/v2/assistants/{assistantId}) Requires permission assistants:assistant:edit. The id is the assistantId. Required: id.
- **get_single_genesys_cloud_audit_query_by_id** — Get status of audit query execution. (GET /api/v2/audits/query/{transactionId}) Requires permission audits:audit:view. The id is the transactionId. Required: id.
- **create_a_genesys_cloud_audit_query_realtime** — This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values. (POST /api/v2/audits/query/realtime) Requires permission audits:audit:view. Required: interval.
- **create_a_genesys_cloud_audit_query_realtime_related** — Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id. (POST /api/v2/audits/query/realtime/related) Requires permission audits:audit:view. Required: auditId.
- **list_all_genesys_cloud_audit_query_realtime_servicemapping** — Get service mapping information used in realtime audits. (GET /api/v2/audits/query/realtime/servicemapping) Requires permission audits:audit:view.
- **genesys_cloud_audit_query_results_lookup** — Get results of audit query. (GET /api/v2/audits/query/{transactionId}/results) Requires permission audits:audit:view. Required: transaction_id.
- **list_all_genesys_cloud_audit_query_servicemapping** — Get service mapping information used in audits. (GET /api/v2/audits/query/servicemapping) Requires permission audits:audit:view.
- **genesys_cloud_audits_search** — Create audit query execution. Use /api/v2/audits/query/servicemapping endpoint for a list of valid values. (POST /api/v2/audits/query) Requires permission audits:audit:view. Required: interval.
- **list_all_genesys_cloud_authorization_division_deleted** — Get a list of soft deleted divisions for the org. (GET /api/v2/authorization/divisions/deleted) Requires permission authorization:divisionDeleted:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_authorization_division_grants** — Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500. (GET /api/v2/authorization/divisions/{divisionId}/grants) Requires permission authorization:grant:view. Pages automatically with pageNumber/pageSize. Required: division_id.
- **genesys_cloud_authorization_division_home_lookup** — Retrieve the home division for the organization. Will not include object counts. (GET /api/v2/authorization/divisions/home)
- **genesys_cloud_authorization_division_limit_lookup** — Returns the maximum allowed number of divisions. (GET /api/v2/authorization/divisions/limit)
- **create_a_genesys_cloud_authorization_division_object** — Assign a list of objects to a division. Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs,. (POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}) Required: division_id, object_type.
- **list_all_genesys_cloud_authorization_division_query** — Retrieve a list of all divisions defined for the organization with cursor. Use "after" and "before" param to fetch next/previous page}. (GET /api/v2/authorization/divisions/query) Pages automatically: pass the returned next_cursor to get the next page.
- **create_a_genesys_cloud_authorization_division** — Create a division. (POST /api/v2/authorization/divisions) Requires permissions authorization:division:add, authorization:grant:add. Required: description.
- **delete_a_genesys_cloud_authorization_division_by_id** — Delete a division. (DELETE /api/v2/authorization/divisions/{divisionId}) Requires permission authorization:division:delete. The id is the divisionId. Required: id.
- **get_single_genesys_cloud_authorization_division_by_id** — Returns an authorization division. (GET /api/v2/authorization/divisions/{divisionId}) The id is the divisionId. Required: id.
- **list_all_genesys_cloud_authorization_divisions** — Retrieve a list of all divisions defined for the organization. Request specific divisions by id using a query param "id", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3. (GET /api/v2/authorization/divisions) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_authorization_divisions_restore** — Recreate a previously deleted division. (POST /api/v2/authorization/divisions/{divisionId}/restore) Requires permission authorization:division:add. Required: division_id, description.
- **update_a_genesys_cloud_authorization_division_by_id** — Update a division. (PUT /api/v2/authorization/divisions/{divisionId}) Requires permission authorization:division:edit. The id is the divisionId. Required: id, description.
- **list_all_genesys_cloud_authorization_divisionspermitted_paged_me** — Returns which divisions the current user has the given permission in. (GET /api/v2/authorization/divisionspermitted/paged/me) Pages automatically with pageNumber/pageSize. Required: permission.
- **list_all_genesys_cloud_authorization_permissions** — Get all permissions. Retrieve a list of all permission defined in the system. (GET /api/v2/authorization/permissions) Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_authorization_policy_by_id** — Get an access control policy with the specified policy ID. (GET /api/v2/authorization/policies/{policyId}) Requires permission authorization:policy:view. The id is the policyId. Required: id.
- **list_all_genesys_cloud_authorization_policies** — Get a page of access policies for an organization. (GET /api/v2/authorization/policies) Requires permission authorization:policy:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_authorization_policy_by_id** — Update an access control policy with a given ID. (PUT /api/v2/authorization/policies/{policyId}) Requires permission authorization:policy:add. The id is the policyId. Required: id, subject, effect.
- **genesys_cloud_authorization_policy_attributes_lookup** — Get the list of attributes used to evaluate an access control policy with the specified policy ID. (GET /api/v2/authorization/policies/{policyId}/attributes) Requires permission authorization:policy:view. Required: policy_id.
- **create_a_genesys_cloud_authorization_policy_simulate** — Simulate a request and evaluate the specified policy ID against the provided values. (POST /api/v2/authorization/policies/{policyId}/simulate) Requires permission authorization:policy:view. Required: policy_id, attributeData.
- **get_single_genesys_cloud_authorization_policy_subject_by_id** — Get a page of access policies for a given subject. (GET /api/v2/authorization/policies/subject/{subjectId}) Requires permission authorization:policy:view. The id is the subjectId. Required: id.
- **delete_a_genesys_cloud_authorization_policy_target_subject_by_id** — Delete an access control policy. (DELETE /api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}) Requires permission authorization:policy:delete. The id is the subjectId. Required: id, target_name.
- **get_authorization_policy_target_subject_by_id** — Get an access control policy for a specified resource target and subject. (GET /api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}) Requires permission authorization:policy:view. The id is the subjectId. Required: id, target_name.
- **create_a_genesys_cloud_authorization_policy_target_validate** — Validate the conditions and attributes of an access control policy for a specified resource target. (POST /api/v2/authorization/policies/targets/{targetName}/validate) Requires permission authorization:policy:add. Required: target_name, subject, effect.
- **create_a_genesys_cloud_authorization_policy_target** — Add an access control policy for a specified resource target and subject. (POST /api/v2/authorization/policies/targets/{targetName}) Requires permission authorization:policy:add. Required: target_name, subject, effect.
- **get_single_genesys_cloud_authorization_policy_target_by_id** — Get a page of access policies for a given policy target. (GET /api/v2/authorization/policies/targets/{targetName}) Requires permission authorization:policy:view. The id is the targetName. Required: id.
- **genesys_cloud_authorization_policy_targets_lookup** — Get a map of policy targets to valid attributes for those targets. (GET /api/v2/authorization/policies/targets) Requires permission authorization:policy:view.
- **update_a_genesys_cloud_authorization_policy_target_by_id** — Add an access control policy for a specified resource target and subject, overwriting any existing policy. (PUT /api/v2/authorization/policies/targets/{targetName}) Requires any of permissions authorization:policy:edit, authorization:policy:add. The id is the targetName. Required: id, subject, effect.
- **list_all_genesys_cloud_authorization_products** — Get the list of enabled products. Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage. (GET /api/v2/authorization/products)
- **create_a_genesys_cloud_authorization_role_comparedefault** — Get an unsaved org role to default role comparison. Allows users to compare their existing roles in an unsaved state to its default role. (POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}) Requires permission authorization:role:view. Required: left_role_id, right_role_id.
- **get_single_genesys_cloud_authorization_role_comparedefault_by_id** — Get an org role to default role comparison. Compares any organization role to a default role id and show differences. (GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}) Requires permission authorization:role:view. The id is the rightRoleId. Required: id, left_role_id.
- **genesys_cloud_authorization_role_default_bulk_update** — Restore specified default roles. (PUT /api/v2/authorization/roles/default) Requires permission authorization:role:edit.
- **create_a_genesys_cloud_authorization_role_default** — Restores all default roles. This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). (POST /api/v2/authorization/roles/default) Requires permission authorization:role:edit.
- **genesys_cloud_authorization_role_settings_bulk_update** — Change authorization role settings. Change role settings. (PUT /api/v2/authorization/roles/settings) Requires any of permissions directory:organization:admin, authorization:settings:edit.
- **genesys_cloud_authorization_role_settings_lookup** — Get authorization role settings. (GET /api/v2/authorization/roles/settings) Requires any of permissions directory:organization:admin, authorization:settings:view.
- **list_all_genesys_cloud_authorization_role_subjectgrants** — Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant. (GET /api/v2/authorization/roles/{roleId}/subjectgrants) Requires permission authorization:role:view. Pages automatically with pageNumber/pageSize. Required: role_id.
- **genesys_cloud_authorization_role_user_add_bulk_update** — Sets the users for the role. (PUT /api/v2/authorization/roles/{roleId}/users/add) Requires permission authorization:grant:add. Required: role_id.
- **genesys_cloud_authorization_role_user_remove_bulk_update** — Removes the users from the role. (PUT /api/v2/authorization/roles/{roleId}/users/remove) Requires permission authorization:grant:delete. Required: role_id.
- **list_all_genesys_cloud_authorization_role_users** — Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role. (GET /api/v2/authorization/roles/{roleId}/users) Pages automatically with pageNumber/pageSize. Required: role_id.
- **create_a_genesys_cloud_authorization_role** — Create an organization role. (POST /api/v2/authorization/roles) Requires permission authorization:role:add. Required: name.
- **delete_a_genesys_cloud_authorization_role_by_id** — Delete an organization role. (DELETE /api/v2/authorization/roles/{roleId}) Requires permission authorization:role:delete. The id is the roleId. Required: id.
- **get_single_genesys_cloud_authorization_role_by_id** — Get a single organization role. Get the organization role specified by its ID. (GET /api/v2/authorization/roles/{roleId}) Requires permission authorization:role:view. The id is the roleId. Required: id.
- **list_all_genesys_cloud_authorization_roles** — Retrieve a list of all roles defined for the organization. (GET /api/v2/authorization/roles) Requires permission authorization:role:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_authorization_roles_partial_update** — Patch Organization Role for needsUpdate Field. (PATCH /api/v2/authorization/roles/{roleId}) Requires permission authorization:role:edit. Required: role_id.
- **update_a_genesys_cloud_authorization_role_by_id** — Update an organization role. Update. (PUT /api/v2/authorization/roles/{roleId}) Requires permission authorization:role:edit. The id is the roleId. Required: id, name.
- **create_a_genesys_cloud_authorization_roles_post** — Bulk-grant subjects and divisions with an organization role. (POST /api/v2/authorization/roles/{roleId}) Requires permission authorization:grant:add. Required: role_id, subjectIds, divisionIds.
- **genesys_cloud_authorization_settings_bulk_partial_update** — Change authorization settings. (PATCH /api/v2/authorization/settings) Requires any of permissions directory:organization:admin, authorization:settings:edit.
- **genesys_cloud_authorization_settings_lookup** — Get authorization settings. (GET /api/v2/authorization/settings) Requires any of permissions directory:organization:admin, authorization:settings:view.
- **create_a_genesys_cloud_authorization_subject_bulkadd** — Bulk-grant roles and divisions to a subject. (POST /api/v2/authorization/subjects/{subjectId}/bulkadd) Requires permission authorization:grant:add. Required: subject_id, grants.
- **create_a_genesys_cloud_authorization_subject_bulkremove** — Bulk-remove grants from a subject. (POST /api/v2/authorization/subjects/{subjectId}/bulkremove) Requires permission authorization:grant:delete. Required: subject_id, grants.
- **create_a_genesys_cloud_authorization_subject_bulkreplace** — Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject. (POST /api/v2/authorization/subjects/{subjectId}/bulkreplace) Requires permissions authorization:grant:add, authorization:grant:delete. Required: subject_id, grants.
- **create_a_genesys_cloud_authorization_subject_division_role** — Make a grant of a role in a division. (POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}) Requires permission authorization:grant:add. Required: subject_id, division_id, role_id.
- **delete_a_genesys_cloud_authorization_subject_division_role_by_id** — Delete a grant of a role in a division. (DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}) Requires permission authorization:grant:delete. The id is the roleId. Required: id, subject_id, division_id.
- **genesys_cloud_authorization_subject_me_lookup** — Returns a listing of roles and permissions for the currently authenticated user. (GET /api/v2/authorization/subjects/me)
- **genesys_cloud_authorization_subject_rolecounts_lookup** — Get the count of roles granted to a list of subjects. (GET /api/v2/authorization/subjects/rolecounts) Requires permission authorization:grant:view.
- **get_single_genesys_cloud_authorization_subject_by_id** — Returns a listing of roles and permissions for a user. (GET /api/v2/authorization/subjects/{subjectId}) Requires permission authorization:grant:view. The id is the subjectId. Required: id.
- **genesys_cloud_billing_report_billableusage_lookup** — Get a report of the billable license usages. Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again. (GET /api/v2/billing/reports/billableusage) Requires any of permissions billing:subscription:read, billing:subscription:view. Required: startDate, endDate.
- **get_single_genesys_cloud_billing_trusteebillingoverview_by_id** — Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. (GET /api/v2/billing/trusteebillingoverview/{trustorOrgId}) Requires permission affiliateOrganization:clientBilling:view. The id is the trustorOrgId. Required: id.
- **create_a_genesys_cloud_businessrule_decisiontable_export** — Create an export job for a decision table version. (POST /api/v2/businessrules/decisiontables/{tableId}/exports) Requires permission businessrules:decisionTableExportJob:add. Required: table_id, exportType, format.
- **delete_a_genesys_cloud_businessrule_decisiontable_export_by_id** — Delete an export job for a decision table. (DELETE /api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}) Requires permission businessrules:decisionTableExportJob:delete. The id is the exportJobId. Required: id, table_id.
- **get_single_genesys_cloud_businessrule_decisiontable_export_by_id** — Get an export job for a decision table. (GET /api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}) Requires permission businessrules:decisionTableExportJob:view. The id is the exportJobId. Required: id, table_id.
- **list_all_genesys_cloud_businessrule_decisiontable_exports** — List export jobs for a decision table. (GET /api/v2/businessrules/decisiontables/{tableId}/exports) Requires permission businessrules:decisionTableExportJob:view. Pages automatically: pass the returned next_cursor to get the next page. Required: table_id.
- **create_a_genesys_cloud_businessrule_decisiontable_import** — Create a decision table row import job. (POST /api/v2/businessrules/decisiontables/{tableId}/imports) Requires permission businessrules:decisionTableImportJob:add. Required: table_id, importMode, fileName.
- **delete_a_genesys_cloud_businessrule_decisiontable_import_by_id** — Delete decision table row import job. (DELETE /api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}) Requires permission businessrules:decisionTableImportJob:delete. The id is the importJobId. Required: id, table_id.
- **get_single_genesys_cloud_businessrule_decisiontable_import_by_id** — Get decision table row import job. (GET /api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}) Requires permission businessrules:decisionTableImportJob:view. The id is the importJobId. Required: id, table_id.
- **list_all_genesys_cloud_businessrule_decisiontable_imports** — List decision table row import jobs. (GET /api/v2/businessrules/decisiontables/{tableId}/imports) Requires permission businessrules:decisionTableImportJob:view. Pages automatically: pass the returned next_cursor to get the next page. Required: table_id.
- **update_a_genesys_cloud_businessrule_decisiontable_import_by_id** — Update decision table row import job. Cancels an in-progress import job by supplying a status of Cancelled. Cancellation is idempotent: cancelling a job that is already Cancelled returns 200 with the cancelled job. Cancelling a job that is still Uploading or Processing returns 200. (PATCH /api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}) Requires permission businessrules:decisionTableImportJob:edit. The id is the importJobId. Required: id, table_id, status.
- **list_all_genesys_cloud_businessrule_decisiontable_search** — Search for decision tables. (GET /api/v2/businessrules/decisiontables/search) Requires permission businessrules:decisionTable:search. Pages automatically: pass the returned next_cursor to get the next page.
- **create_a_genesys_cloud_businessrule_decisiontable_version_copy** — Copy a decision table version. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/copy) Requires permission businessrules:decisionTable:copy. Required: table_id, table_version, name.
- **businessrule_decisiontable_version_publish_bulk_update** — Publish a decision table version. (PUT /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/publish) Requires permission businessrules:decisionTable:publish. Required: table_id, table_version.
- **create_businessrule_decisiontable_version_rollback** — Re-publish a superseded decision table version as the current published version. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rollback) Requires permission businessrules:decisionTable:rollback. Required: table_id, table_version.
- **create_businessrule_decisiontable_version_row_bulk_add** — Bulk add decision table rows. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/add) Requires permissions businessrules:decisionTableRow:add, routing:queue:view. Required: table_id, table_version, rows.
- **create_businessrule_decisiontable_version_row_bulk_remove** — Bulk delete decision table rows. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/remove) Requires permissions businessrules:decisionTableRow:delete, routing:queue:view. Required: table_id, table_version, rowIds.
- **create_businessrule_decisiontable_version_row_bulk_update** — Bulk update decision table rows. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/update) Requires permissions businessrules:decisionTableRow:edit, routing:queue:view. Required: table_id, table_version, rows.
- **create_a_genesys_cloud_businessrule_decisiontable_version_row** — Create a decision table row. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows) Requires permissions businessrules:decisionTableRow:add, routing:queue:view. Required: table_id, table_version, inputs, outputs.
- **delete_businessrule_decisiontable_version_row_by_id** — Delete a decision table row. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (DELETE /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}) Requires permissions businessrules:decisionTableRow:delete, routing:queue:view. The id is the rowId. Required: id, table_id, table_version.
- **get_businessrule_decisiontable_version_row_by_id** — Get a decision table row. (GET /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}) Requires permission businessrules:decisionTableRow:view. The id is the rowId. Required: id, table_id, table_version.
- **list_all_genesys_cloud_businessrule_decisiontable_version_rows** — Get a list of decision table rows. (GET /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows) Requires permission businessrules:decisionTableRow:view. Pages automatically with pageNumber/pageSize. Required: table_id, table_version.
- **genesys_cloud_businessrule_decisiontable_version_rows_search** — Search for decision table rows. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/search) Requires permission businessrules:decisionTableRow:search. Required: table_id, table_version, filter.
- **update_businessrule_decisiontable_version_row_by_id** — Full update a decision table row. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (PUT /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}) Requires permissions businessrules:decisionTableRow:edit, routing:queue:view. The id is the rowId. Required: id, table_id, table_version.
- **businessrule_decisiontable_version_snapshot_bulk_delete** — Deletes a decision table version snapshot. (DELETE /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/snapshot) Requires permission businessrules:decisionTableSnapshot:delete. Required: table_id, table_version.
- **create_businessrule_decisiontable_version_snapshot** — Creates a decision table version snapshot. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/snapshot) Requires permission businessrules:decisionTableSnapshot:add. Required: table_id, table_version, snapshotName.
- **create_a_genesys_cloud_businessrule_decisiontable_version_sync** — Update the Business Rules Schema to the latest version for a given decision table version. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/sync) Requires permission businessrules:decisionTable:edit. Required: table_id, table_version.
- **create_a_genesys_cloud_businessrule_decisiontable_version** — Create a new decision table version. When sourceVersion is not provided, the draft is created from the published version. (POST /api/v2/businessrules/decisiontables/{tableId}/versions) Requires permission businessrules:decisionTable:add. Required: table_id.
- **delete_a_genesys_cloud_businessrule_decisiontable_version_by_id** — Delete a decision table version. (DELETE /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}) Requires permission businessrules:decisionTable:delete. The id is the tableVersion. Required: id, table_id.
- **genesys_cloud_businessrule_decisiontable_versions_execute** — Execute a decision table version. Example request payload: {"inputs":{"schemaPropertykey1":"inputValue1","schemaPropertykey2":"inputValue2"}}. (POST /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/execute) Requires permission businessrules:decisionTable:execute. Required: table_id, table_version, inputs.
- **get_businessrule_decisiontable_version_by_id** — Get a decision table version. (GET /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}) Requires permission businessrules:decisionTable:view. The id is the tableVersion. Required: id, table_id.
- **list_all_genesys_cloud_businessrule_decisiontable_versions** — Get a list of decision table versions. (GET /api/v2/businessrules/decisiontables/{tableId}/versions) Requires permission businessrules:decisionTable:view. Pages automatically: pass the returned next_cursor to get the next page. Required: table_id.
- **update_a_genesys_cloud_businessrule_decisiontable_version_by_id** — Update a decision table version. (PATCH /api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}) Requires permission businessrules:decisionTable:edit. The id is the tableVersion. Required: id, table_id.
- **create_a_genesys_cloud_businessrule_decisiontable** — Create a decision table. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (POST /api/v2/businessrules/decisiontables) Requires permissions businessrules:decisionTable:add, businessrules:businessRulesSchema:view, routing:queue:view. Required: name, divisionId, schemaId, columns.
- **delete_a_genesys_cloud_businessrule_decisiontable_by_id** — Delete a decision table. (DELETE /api/v2/businessrules/decisiontables/{tableId}) Requires permission businessrules:decisionTable:delete. The id is the tableId. Required: id.
- **genesys_cloud_businessrule_decisiontables_execute** — Execute a published decision table. Example request payload: {"inputs":{"schemaPropertykey1":"inputValue1","schemaPropertykey2":"inputValue2"}}. (POST /api/v2/businessrules/decisiontables/{tableId}/execute) Requires permission businessrules:decisionTable:execute. Required: table_id, inputs.
- **get_single_genesys_cloud_businessrule_decisiontable_by_id** — Get a decision table. (GET /api/v2/businessrules/decisiontables/{tableId}) Requires permission businessrules:decisionTable:view. The id is the tableId. Required: id.
- **list_all_genesys_cloud_businessrule_decisiontables** — Get a list of decision tables. (GET /api/v2/businessrules/decisiontables) Requires permission businessrules:decisionTable:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_businessrule_decisiontable_by_id** — Update a decision table. Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queue's division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them. (PATCH /api/v2/businessrules/decisiontables/{tableId}) Requires permissions businessrules:decisionTable:edit, businessrules:businessRulesSchema:view, routing:queue:view. The id is the tableId. Required: id.
- **get_single_genesys_cloud_businessrule_schema_coretype_by_id** — Get a specific named core type. (GET /api/v2/businessrules/schemas/coretypes/{coreTypeName}) Requires permission businessrules:businessRulesSchema:view. The id is the coreTypeName. Required: id.
- **list_all_genesys_cloud_businessrule_schema_coretypes** — Get the core types from which all schemas are built. (GET /api/v2/businessrules/schemas/coretypes) Requires permission businessrules:businessRulesSchema:view.
- **get_single_genesys_cloud_businessrule_schema_version_by_id** — Get a schema version. (GET /api/v2/businessrules/schemas/{schemaId}/versions/{schemaVersion}) Requires permission businessrules:businessRulesSchema:view. The id is the schemaVersion. Required: id, schema_id.
- **list_all_genesys_cloud_businessrule_schema_versions** — List schema versions. (GET /api/v2/businessrules/schemas/{schemaId}/versions) Requires permission businessrules:businessRulesSchema:view. Pages automatically: pass the returned next_cursor to get the next page. Required: schema_id.
- **create_a_genesys_cloud_businessrule_schema** — Create a schema. (POST /api/v2/businessrules/schemas) Requires permission businessrules:businessRulesSchema:add. Required: jsonSchema.
- **delete_a_genesys_cloud_businessrule_schema_by_id** — Delete a schema. (DELETE /api/v2/businessrules/schemas/{schemaId}) Requires permission businessrules:businessRulesSchema:delete. The id is the schemaId. Required: id.
- **get_single_genesys_cloud_businessrule_schema_by_id** — Get a schema. (GET /api/v2/businessrules/schemas/{schemaId}) Requires permission businessrules:businessRulesSchema:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_businessrule_schemas** — Get a list of schemas. (GET /api/v2/businessrules/schemas) Requires permission businessrules:businessRulesSchema:view.
- **update_a_genesys_cloud_businessrule_schema_by_id** — Update a schema. (PUT /api/v2/businessrules/schemas/{schemaId}) Requires permission businessrules:businessRulesSchema:edit. The id is the schemaId. Required: id, version, jsonSchema.
- **create_carrierservice_integration_emergencylocation_me** — Set current location for the logged in user. (POST /api/v2/carrierservices/integrations/emergencylocations/me) Required: address, did, source.
- **carrierservice_integration_emergencylocation_me_lookup** — Get location for the logged in user. (GET /api/v2/carrierservices/integrations/emergencylocations/me) Required: phoneNumber.
- **create_a_genesys_cloud_casemanagement_case_association** — Create a Case association. (POST /api/v2/casemanagement/cases/{caseId}/associations) Requires permission caseManagement:caseAssociation:add. Required: case_id.
- **get_single_genesys_cloud_casemanagement_case_association_by_id** — Get a Case Association. (GET /api/v2/casemanagement/cases/{caseId}/associations/{associationId}) Requires permission caseManagement:caseAssociation:view. The id is the associationId. Required: id, case_id.
- **list_all_genesys_cloud_casemanagement_case_associations** — Get a list of Case associations for the Case. (GET /api/v2/casemanagement/cases/{caseId}/associations) Requires permission caseManagement:caseAssociation:view. Pages automatically: pass the returned next_cursor to get the next page. Required: case_id.
- **genesys_cloud_casemanagement_case_associations_search** — Query for Case associations by interaction. (POST /api/v2/casemanagement/cases/associations/query) Requires permission caseManagement:caseAssociation:view.
- **delete_a_genesys_cloud_casemanagement_case_comment_me_by_id** — Delete my Comment. (DELETE /api/v2/casemanagement/cases/{caseId}/comments/me/{commentId}) Requires permission caseManagement:commentSelf:delete. The id is the commentId. Required: id, case_id.
- **create_a_genesys_cloud_casemanagement_case_comment** — Add a comment to a Case. (POST /api/v2/casemanagement/cases/{caseId}/comments) Requires permission caseManagement:comment:add. Required: case_id, content.
- **get_single_genesys_cloud_casemanagement_case_comment_by_id** — Get a Comment. (GET /api/v2/casemanagement/cases/{caseId}/comments/{commentId}) Requires permission caseManagement:comment:view. The id is the commentId. Required: id, case_id.
- **list_all_genesys_cloud_casemanagement_case_comments** — Get comments for a Case. (GET /api/v2/casemanagement/cases/{caseId}/comments) Requires permission caseManagement:comment:view. Pages automatically: pass the returned next_cursor to get the next page. Required: case_id.
- **genesys_cloud_casemanagement_case_datedue_bulk_partial_update** — Update the due date of a Case. (PATCH /api/v2/casemanagement/cases/{caseId}/datedue) Requires permission caseManagement:caseDateDue:edit. Required: case_id, dateDue.
- **get_casemanagement_case_externalcontact_by_id** — Get a list of Cases for an External Contact. (GET /api/v2/casemanagement/cases/externalcontacts/{externalContactId}) Requires permission caseManagement:caseExternalContact:view. The id is the externalContactId. Required: id.
- **genesys_cloud_casemanagement_case_owner_bulk_partial_update** — Update the ownerId of a Case. (PATCH /api/v2/casemanagement/cases/{caseId}/owner) Requires permission caseManagement:caseOwner:edit. Required: case_id, ownerId.
- **genesys_cloud_casemanagement_case_priority_bulk_partial_update** — Update priority of a Case. (PATCH /api/v2/casemanagement/cases/{caseId}/priority) Requires permission caseManagement:casePriority:edit. Required: case_id, priority.
- **list_all_genesys_cloud_casemanagement_case_query_job_results** — Get results for a case query job. (GET /api/v2/casemanagement/cases/query/jobs/{jobId}/results) Requires permission caseManagement:queryJobResults:view. Required: job_id.
- **create_a_genesys_cloud_casemanagement_case_query_job** — Create a Case query job. (POST /api/v2/casemanagement/cases/query/jobs) Requires permission caseManagement:queryJob:add. Required: filters.
- **get_single_genesys_cloud_casemanagement_case_query_job_by_id** — Get a case query job by id. (GET /api/v2/casemanagement/cases/query/jobs/{jobId}) Requires permission caseManagement:queryJob:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_casemanagement_case_reference_by_id** — Get a Case by reference. (GET /api/v2/casemanagement/cases/references/{referenceId}) Requires permission caseManagement:caseReference:view. The id is the referenceId. Required: id.
- **get_single_genesys_cloud_casemanagement_case_stage_step_by_id** — Get a Step. (GET /api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps/{stepId}) Requires permission caseManagement:step:view. The id is the stepId. Required: id, case_id, stage_id.
- **list_all_genesys_cloud_casemanagement_case_stage_steps** — Get a list of Steps. (GET /api/v2/casemanagement/cases/{caseId}/stages/{stageId}/steps) Requires permission caseManagement:step:view. Pages automatically: pass the returned next_cursor to get the next page. Required: case_id, stage_id.
- **get_single_genesys_cloud_casemanagement_case_stage_by_id** — Get a Stage. (GET /api/v2/casemanagement/cases/{caseId}/stages/{stageId}) Requires permission caseManagement:stage:view. The id is the stageId. Required: id, case_id.
- **list_all_genesys_cloud_casemanagement_case_stages** — Get a list of Stages. (GET /api/v2/casemanagement/cases/{caseId}/stages) Requires permission caseManagement:stage:view. Pages automatically: pass the returned next_cursor to get the next page. Required: case_id.
- **genesys_cloud_casemanagement_case_summary_bulk_partial_update** — Update summary of a Case. (PATCH /api/v2/casemanagement/cases/{caseId}/summary) Requires permission caseManagement:caseSummary:edit. Required: case_id, summary.
- **create_a_genesys_cloud_casemanagement_case_terminate_job** — Create a Terminate Job for a Case. (POST /api/v2/casemanagement/cases/{caseId}/terminate/jobs) Requires permission caseManagement:terminateJob:add. Required: case_id.
- **get_single_genesys_cloud_casemanagement_case_terminate_job_by_id** — Get a Terminate Job for a Case. (GET /api/v2/casemanagement/cases/{caseId}/terminate/jobs/{jobId}) Requires permission caseManagement:terminateJob:view. The id is the jobId. Required: id, case_id.
- **create_a_genesys_cloud_casemanagement_caseplan_dataschema** — Add a data schema to a draft Caseplan. (POST /api/v2/casemanagement/caseplans/{caseplanId}/dataschemas) Requires permission caseManagement:caseplanDataSchemas:add. Required: caseplan_id, id.
- **delete_a_genesys_cloud_casemanagement_caseplan_dataschema_by_id** — Remove a data schema from a draft Caseplan. (DELETE /api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}) Requires permission caseManagement:caseplanDataSchemas:delete. The id is the schemaKeyName. Required: id, caseplan_id.
- **update_a_genesys_cloud_casemanagement_caseplan_dataschema_by_id** — Update a data schema on a draft Caseplan. (PUT /api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}) Requires permission caseManagement:caseplanDataSchemas:edit. The id is the schemaKeyName. Required: id, caseplan_id.
- **genesys_cloud_casemanagement_caseplan_intakesettings_bulk_update** — Update the intake settings for a Caseplan. (PUT /api/v2/casemanagement/caseplans/{caseplanId}/intakesettings) Requires permission caseManagement:caseplanIntakeSettings:edit. Required: caseplan_id.
- **create_casemanagement_caseplan_stageplan_reposition** — Reposition a Stageplan within a draft Caseplan. (POST /api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/reposition) Requires permission caseManagement:stageplan:reposition. Required: caseplan_id, stageplan_id.
- **update_casemanagement_caseplan_stageplan_stepplan_by_id** — Update the attributes of a Stepplan. (PATCH /api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}/stepplans/{stepplanId}) Requires permission caseManagement:stepplan:edit. The id is the stepplanId. Required: id, caseplan_id, stageplan_id.
- **create_a_genesys_cloud_casemanagement_caseplan_stageplan** — Create a Stageplan on a draft Caseplan. (POST /api/v2/casemanagement/caseplans/{caseplanId}/stageplans) Requires permission caseManagement:stageplan:add. Required: caseplan_id, name.
- **delete_a_genesys_cloud_casemanagement_caseplan_stageplan_by_id** — Delete a Stageplan from a draft Caseplan. (DELETE /api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}) Requires permission caseManagement:stageplan:delete. The id is the stageplanId. Required: id, caseplan_id.
- **update_a_genesys_cloud_casemanagement_caseplan_stageplan_by_id** — Update the attributes of a Stageplan. (PATCH /api/v2/casemanagement/caseplans/{caseplanId}/stageplans/{stageplanId}) Requires permission caseManagement:stageplan:edit. The id is the stageplanId. Required: id, caseplan_id.
- **list_all_casemanagement_caseplan_version_dataschemas** — Get the data schemas for a Caseplan version. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/dataschemas) Requires permission caseManagement:caseplanDataSchemas:view. Required: caseplan_id, version_id.
- **list_all_casemanagement_caseplan_version_intakesettings** — Get the intake settings for a Caseplan version. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/intakesettings) Requires permission caseManagement:caseplanIntakeSettings:view. Required: caseplan_id, version_id.
- **get_casemanagement_caseplan_version_stageplan_stepplan_by_id** — Get a Stepplan. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans/{stepplanId}) Requires permission caseManagement:stepplan:view. The id is the stepplanId. Required: id, caseplan_id, version_id, stageplan_id.
- **list_all_casemanagement_caseplan_version_stageplan_stepplans** — Get a list of Stepplans. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}/stepplans) Requires permission caseManagement:stepplan:view. Pages automatically: pass the returned next_cursor to get the next page. Required: caseplan_id, version_id, stageplan_id.
- **get_casemanagement_caseplan_version_stageplan_by_id** — Get a Stageplan. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans/{stageplanId}) Requires permission caseManagement:stageplan:view. The id is the stageplanId. Required: id, caseplan_id, version_id.
- **list_all_casemanagement_caseplan_version_stageplans** — Get a list of Stageplans. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}/stageplans) Requires permission caseManagement:stageplan:view. Pages automatically: pass the returned next_cursor to get the next page. Required: caseplan_id, version_id.
- **create_a_genesys_cloud_casemanagement_caseplan_version** — Create Caseplan version. (POST /api/v2/casemanagement/caseplans/{caseplanId}/versions) Requires permission caseManagement:caseplan:edit. Required: caseplan_id.
- **get_single_genesys_cloud_casemanagement_caseplan_version_by_id** — Get a Caseplan version. (GET /api/v2/casemanagement/caseplans/{caseplanId}/versions/{versionId}) Requires permission caseManagement:caseplan:version. The id is the versionId. Required: id, caseplan_id.
- **create_a_genesys_cloud_casemanagement_caseplan** — Create a Caseplan. (POST /api/v2/casemanagement/caseplans) Requires permission caseManagement:caseplan:add. Required: name, referencePrefix, customerIntentId, divisionId.
- **delete_a_genesys_cloud_casemanagement_caseplan_by_id** — Delete a Caseplan. (DELETE /api/v2/casemanagement/caseplans/{caseplanId}) Requires permission caseManagement:caseplan:delete. The id is the caseplanId. Required: id.
- **get_single_genesys_cloud_casemanagement_caseplan_by_id** — Get a Caseplan. (GET /api/v2/casemanagement/caseplans/{caseplanId}) Requires permission caseManagement:caseplan:view. The id is the caseplanId. Required: id.
- **list_all_genesys_cloud_casemanagement_caseplans** — Get a list of Caseplans. (GET /api/v2/casemanagement/caseplans) Requires permission caseManagement:caseplan:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_casemanagement_caseplans_publish** — Publish Caseplan. (POST /api/v2/casemanagement/caseplans/{caseplanId}/publish) Requires permission caseManagement:caseplan:publish. Required: caseplan_id.
- **genesys_cloud_casemanagement_caseplans_search** — Query for Caseplans. This endpoint supports two filtering modes. The recommended approach uses 'filters' (generic filter model) and 'attributes' (field projection). During the migration period, the legacy fields 'name', 'nameSearchType', and 'divisionIds' remain available as an alternative. (POST /api/v2/casemanagement/caseplans/query) Requires permission caseManagement:caseplan:view.
- **update_a_genesys_cloud_casemanagement_caseplan_by_id** — Update the attributes of a Caseplan. (PATCH /api/v2/casemanagement/caseplans/{caseplanId}) Requires permission caseManagement:caseplan:edit. The id is the caseplanId. Required: id.
- **create_a_genesys_cloud_casemanagement_case** — Create a Case. (POST /api/v2/casemanagement/cases) Requires permission caseManagement:case:add. Required: caseplanId, externalContactId.
- **delete_a_genesys_cloud_casemanagement_case_by_id** — Delete a Case. (DELETE /api/v2/casemanagement/cases/{caseId}) Requires permission caseManagement:case:delete. The id is the caseId. Required: id.
- **get_single_genesys_cloud_casemanagement_case_by_id** — Get a Case. (GET /api/v2/casemanagement/cases/{caseId}) Requires permission caseManagement:case:view. The id is the caseId. Required: id.
- **create_a_genesys_cloud_certificate_detail** — Returns the information about an X509 PEM encoded certificate or certificate chain. (POST /api/v2/certificate/details) Required: certificate.
- **genesys_cloud_chat_message_reactions_bulk_update** — Update reactions to a message. (PUT /api/v2/chats/messages/{messageId}/reactions) Requires any of permissions chat:chat:access, chat:reactions:edit. Required: message_id, reactions.
- **get_single_genesys_cloud_chat_message_by_id** — Get a message. (GET /api/v2/chats/messages/{messageId}) Requires any of permissions chat:chat:access, chat:1on1Message:view, chat:room:view. The id is the messageId. Required: id.
- **create_a_genesys_cloud_chat_room_message_pin** — Add pinned messages for a room, up to a maximum of 5 pinned messages. (POST /api/v2/chats/rooms/{roomJid}/messages/pins) Requires any of permissions chat:chat:access, chat:room:edit. Required: room_jid, pinnedMessageIds.
- **delete_a_genesys_cloud_chat_room_message_pin_by_id** — Remove a pinned message from a room. (DELETE /api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}) Requires any of permissions chat:chat:access, chat:room:edit. The id is the pinnedMessageId. Required: id, room_jid.
- **create_a_genesys_cloud_chat_room_message** — Send a message to a room. (POST /api/v2/chats/rooms/{roomJid}/messages) Requires any of permissions chat:chat:access, chat:roomMessage:add. Required: room_jid, message.
- **delete_a_genesys_cloud_chat_room_message_by_id** — Delete a message in a room. (DELETE /api/v2/chats/rooms/{roomJid}/messages/{messageId}) Requires any of permissions chat:chat:access, chat:roomMessage:delete. The id is the messageId. Required: id, room_jid.
- **get_single_genesys_cloud_chat_room_message_by_id** — Get messages by id(s) from a room. (GET /api/v2/chats/rooms/{roomJid}/messages/{messageIds}) Requires any of permissions chat:chat:access, chat:room:view. The id is the messageIds. Required: id, room_jid.
- **list_all_genesys_cloud_chat_room_messages** — Get a room's message history. (GET /api/v2/chats/rooms/{roomJid}/messages) Requires any of permissions chat:chat:access, chat:room:view. Required: room_jid.
- **update_a_genesys_cloud_chat_room_message_by_id** — Edit a message in a room. (PATCH /api/v2/chats/rooms/{roomJid}/messages/{messageId}) Requires any of permissions chat:chat:access, chat:roomMessage:edit. The id is the messageId. Required: id, room_jid.
- **create_a_genesys_cloud_chat_room_participant** — Join a room. (POST /api/v2/chats/rooms/{roomJid}/participants/{userId}) Requires any of permissions chat:chat:access, chat:participant:add. Required: room_jid, user_id.
- **delete_a_genesys_cloud_chat_room_participant_by_id** — Remove a user from a room. (DELETE /api/v2/chats/rooms/{roomJid}/participants/{userId}) Requires any of permissions chat:chat:access, chat:participant:delete. The id is the userId. Required: id, room_jid.
- **get_single_genesys_cloud_chat_room_participant_by_id** — Get a room participant. (GET /api/v2/chats/rooms/{roomJid}/participants/{participantJid}) The id is the participantJid. Required: id, room_jid.
- **list_all_genesys_cloud_chat_room_participants** — Get room participants in a room. (GET /api/v2/chats/rooms/{roomJid}/participants) Requires any of permissions chat:chat:access, chat:room:view. Required: room_jid.
- **create_a_genesys_cloud_chat_room** — Create an adhoc room. (POST /api/v2/chats/rooms) Requires any of permissions chat:chat:access, chat:room:add. Required: subject.
- **get_single_genesys_cloud_chat_room_by_id** — Get a room. (GET /api/v2/chats/rooms/{roomJid}) Requires any of permissions chat:chat:access, chat:room:view. The id is the roomJid. Required: id.
- **update_a_genesys_cloud_chat_room_by_id** — Set properties for a room. (PATCH /api/v2/chats/rooms/{roomJid}) Requires any of permissions chat:chat:access, chat:room:edit. The id is the roomJid. Required: id.
- **genesys_cloud_chat_settings_bulk_partial_update** — Patch Chat Settings. (PATCH /api/v2/chats/settings) Requires permission chat:setting:edit.
- **genesys_cloud_chat_settings_bulk_update** — Update Chat Settings. (PUT /api/v2/chats/settings) Requires permission chat:setting:edit.
- **genesys_cloud_chat_settings_lookup** — Get Chat Settings. (GET /api/v2/chats/settings) Requires any of permissions chat:setting:view, chat:setting:edit.
- **list_all_genesys_cloud_chat_thread_messages** — Get history by thread. (GET /api/v2/chats/threads/{threadId}/messages) Requires any of permissions chat:chat:access, chat:room:view. Required: thread_id.
- **genesys_cloud_chat_user_me_settings_bulk_delete** — Delete a user's chat settings. (DELETE /api/v2/chats/users/me/settings)
- **genesys_cloud_chat_user_me_settings_bulk_partial_update** — Update a user's chat settings. (PATCH /api/v2/chats/users/me/settings) Required: mobile.
- **create_a_genesys_cloud_chat_user_me_setting** — Create a user's chat settings. (POST /api/v2/chats/users/me/settings) Required: muted.
- **genesys_cloud_chat_user_me_settings_lookup** — Get a user's chat settings. (GET /api/v2/chats/users/me/settings)
- **create_a_genesys_cloud_chat_user_message_pin** — Add pinned messages for a 1on1, up to a maximum of 5 pinned messages. (POST /api/v2/chats/users/{userId}/messages/pins) Requires any of permissions chat:chat:access, chat:1on1:edit. Required: user_id, pinnedMessageIds.
- **delete_a_genesys_cloud_chat_user_message_pin_by_id** — Remove a pinned message from a 1on1. (DELETE /api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}) Requires any of permissions chat:chat:access, chat:1on1:edit. The id is the pinnedMessageId. Required: id, user_id.
- **create_a_genesys_cloud_chat_user_message** — Send a message to a user. (POST /api/v2/chats/users/{userId}/messages) Requires any of permissions chat:chat:access, chat:1on1Message:add. Required: user_id, message.
- **delete_a_genesys_cloud_chat_user_message_by_id** — Delete a message to a user. (DELETE /api/v2/chats/users/{userId}/messages/{messageId}) Requires any of permissions chat:chat:access, chat:1on1Message:delete. The id is the messageId. Required: id, user_id.
- **get_single_genesys_cloud_chat_user_message_by_id** — Get messages by id(s) from a 1on1. (GET /api/v2/chats/users/{userId}/messages/{messageIds}) Requires any of permissions chat:chat:access, chat:1on1Message:view. The id is the messageIds. Required: id, user_id.
- **genesys_cloud_chat_user_messages_lookup** — Get 1on1 History between a user. (GET /api/v2/chats/users/{userId}/messages) Requires any of permissions chat:chat:access, chat:1on1Message:view. Required: user_id.
- **update_a_genesys_cloud_chat_user_message_by_id** — Edit a message to a user. (PATCH /api/v2/chats/users/{userId}/messages/{messageId}) Requires any of permissions chat:chat:access, chat:1on1Message:view. The id is the messageId. Required: id, user_id.
- **genesys_cloud_chat_user_settings_bulk_partial_update** — Update a user's chat settings. (PATCH /api/v2/chats/users/{userId}/settings) Requires any of permissions chat:usersettings:edit, chat:setting:edit. Required: user_id, mobile.
- **genesys_cloud_chat_user_settings_lookup** — Get a user's chat settings. (GET /api/v2/chats/users/{userId}/settings) Requires any of permissions chat:usersettings:view, chat:setting:view. Required: user_id.
- **get_single_genesys_cloud_chat_user_by_id** — Get information for a 1on1. (GET /api/v2/chats/users/{userId}) Requires any of permissions chat:chat:access, chat:1on1:view. The id is the userId. Required: id.
- **genesys_cloud_coaching_appointment_aggregates_search** — Retrieve aggregated appointment data. (POST /api/v2/coaching/appointments/aggregates/query) Requires permission coaching:appointment:view. Required: interval, filter.
- **create_a_genesys_cloud_coaching_appointment_annotation** — Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations). (POST /api/v2/coaching/appointments/{appointmentId}/annotations) Requires any of permissions coaching:annotation:add, coaching:privateAnnotation:add. Required: appointment_id, text, accessType.
- **delete_a_genesys_cloud_coaching_appointment_annotation_by_id** — Delete an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment. (DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}) Requires any of permissions coaching:annotation:delete, coaching:privateAnnotation:delete. The id is the annotationId. Required: id, appointment_id.
- **get_single_genesys_cloud_coaching_appointment_annotation_by_id** — Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations). (GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}) Requires any of permissions coaching:annotation:view, coaching:privateAnnotation:view. The id is the annotationId. Required: id, appointment_id.
- **list_all_genesys_cloud_coaching_appointment_annotations** — Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations). (GET /api/v2/coaching/appointments/{appointmentId}/annotations) Requires any of permissions coaching:annotation:view, coaching:privateAnnotation:view. Pages automatically with pageNumber/pageSize. Required: appointment_id.
- **update_a_genesys_cloud_coaching_appointment_annotation_by_id** — Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment. (PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId}) Requires any of permissions coaching:annotation:edit, coaching:privateAnnotation:edit. The id is the annotationId. Required: id, appointment_id, text.
- **create_a_genesys_cloud_coaching_appointment_conversation** — Add a conversation to an appointment. Permission not required if you are the creator or facilitator of the appointment. (POST /api/v2/coaching/appointments/{appointmentId}/conversations) Requires any of permissions coaching:appointment:edit, coaching:appointmentConversation:add. Required: appointment_id, conversationId.
- **list_all_genesys_cloud_coaching_appointment_me** — Get my appointments for a given date range. (GET /api/v2/coaching/appointments/me) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_coaching_appointment_status_bulk_partial_update** — Update the status of a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment. (PATCH /api/v2/coaching/appointments/{appointmentId}/status) Requires permission coaching:appointmentStatus:edit. Required: appointment_id, status.
- **list_all_genesys_cloud_coaching_appointment_statuses** — Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment. (GET /api/v2/coaching/appointments/{appointmentId}/statuses) Requires permission coaching:appointmentStatus:view. Pages automatically with pageNumber/pageSize. Required: appointment_id.
- **create_a_genesys_cloud_coaching_appointment** — Create a new appointment. (POST /api/v2/coaching/appointments) Requires permission coaching:appointment:add. Required: name, description, dateStart, lengthInMinutes, attendeeIds.
- **delete_a_genesys_cloud_coaching_appointment_by_id** — Delete an existing appointment. Permission not required if you are the creator of the appointment. (DELETE /api/v2/coaching/appointments/{appointmentId}) Requires permission coaching:appointment:delete. The id is the appointmentId. Required: id.
- **get_single_genesys_cloud_coaching_appointment_by_id** — Retrieve an appointment. Permission not required if you are the attendee, creator or facilitator of the appointment. (GET /api/v2/coaching/appointments/{appointmentId}) Requires permission coaching:appointment:view. The id is the appointmentId. Required: id.
- **list_all_genesys_cloud_coaching_appointments** — Get appointments for users and optional date range. (GET /api/v2/coaching/appointments) Requires permission coaching:appointment:view. Pages automatically with pageNumber/pageSize. Required: userIds.
- **update_a_genesys_cloud_coaching_appointment_by_id** — Update an existing appointment. Permission not required if you are the creator or facilitator of the appointment. (PATCH /api/v2/coaching/appointments/{appointmentId}) Requires permission coaching:appointment:edit. The id is the appointmentId. Required: id.
- **get_single_genesys_cloud_coaching_notification_by_id** — Get an existing notification. Permission not required if you are the owner of the notification. (GET /api/v2/coaching/notifications/{notificationId}) Requires permission coaching:notification:view. The id is the notificationId. Required: id.
- **list_all_genesys_cloud_coaching_notifications** — Retrieve the list of your notifications. (GET /api/v2/coaching/notifications) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_coaching_notification_by_id** — Update an existing notification. Can only update your own notifications. (PATCH /api/v2/coaching/notifications/{notificationId}) The id is the notificationId. Required: id.
- **create_a_genesys_cloud_coaching_scheduleslot_job** — Start job to retrieve the slots where a coaching appointment can be scheduled. (POST /api/v2/coaching/scheduleslots/jobs) Requires permission coaching:scheduleSlotJob:add. Required: attendeeIds, lengthInMinutes, activityCodeId, intervals, slotsType.
- **get_single_genesys_cloud_coaching_scheduleslot_job_by_id** — Retrieve the status of the job for the slots where a coaching appointment can be scheduled. (GET /api/v2/coaching/scheduleslots/jobs/{jobId}) Requires permission coaching:scheduleSlotJob:view. The id is the jobId. Required: id.
- **genesys_cloud_coaching_scheduleslots_search** — Get list of possible slots where a coaching appointment can be scheduled. (POST /api/v2/coaching/scheduleslots/query) Requires permission coaching:scheduleSlot:view. Required: interval, lengthInMinutes, attendeeIds.
- **genesys_cloud_contentmanagement_search** — Query content. (POST /api/v2/contentmanagement/query)
- **create_a_genesys_cloud_contentmanagement_document_content** — Replace the contents of a document. (POST /api/v2/contentmanagement/documents/{documentId}/content) Requires permission content_management_user. Required: document_id.
- **genesys_cloud_contentmanagement_document_content_lookup** — Download a document. (GET /api/v2/contentmanagement/documents/{documentId}/content) Requires permission content_management_user. Required: document_id.
- **create_a_genesys_cloud_contentmanagement_document** — Add a document. (POST /api/v2/contentmanagement/documents) Required: name, workspace.
- **delete_a_genesys_cloud_contentmanagement_document_by_id** — Delete a document. (DELETE /api/v2/contentmanagement/documents/{documentId}) Requires permission content_management_user. The id is the documentId. Required: id.
- **get_single_genesys_cloud_contentmanagement_document_by_id** — Get a document. (GET /api/v2/contentmanagement/documents/{documentId}) Requires permission content_management_user. The id is the documentId. Required: id.
- **create_a_genesys_cloud_contentmanagement_documents_post** — Update a document. (POST /api/v2/contentmanagement/documents/{documentId}) Requires permission content_management_user. Required: document_id, name.
- **genesys_cloud_contentmanagement_query_lookup** — Query content. (GET /api/v2/contentmanagement/query) Required: queryPhrase.
- **get_single_genesys_cloud_contentmanagement_securityprofile_by_id** — Get a Security Profile. (GET /api/v2/contentmanagement/securityprofiles/{securityProfileId}) The id is the securityProfileId. Required: id.
- **list_all_genesys_cloud_contentmanagement_securityprofiles** — Get a List of Security Profiles. (GET /api/v2/contentmanagement/securityprofiles)
- **get_single_genesys_cloud_contentmanagement_shared_by_id** — Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share. (GET /api/v2/contentmanagement/shared/{sharedId}) The id is the sharedId. Required: id.
- **create_a_genesys_cloud_contentmanagement_share** — Creates a new share or updates an existing share if the entity has already been shared. (POST /api/v2/contentmanagement/shares) Required: sharedEntityType, sharedEntity.
- **delete_a_genesys_cloud_contentmanagement_share_by_id** — Deletes an existing share. This revokes sharing rights specified in the share record. (DELETE /api/v2/contentmanagement/shares/{shareId}) The id is the shareId. Required: id.
- **get_single_genesys_cloud_contentmanagement_share_by_id** — Retrieve details about an existing share. (GET /api/v2/contentmanagement/shares/{shareId}) The id is the shareId. Required: id.
- **list_all_genesys_cloud_contentmanagement_shares** — Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400. (GET /api/v2/contentmanagement/shares) Pages automatically with pageNumber/pageSize.
- **delete_a_genesys_cloud_contentmanagement_status_by_id** — Cancel the command for this status. (DELETE /api/v2/contentmanagement/status/{statusId}) The id is the statusId. Required: id.
- **get_single_genesys_cloud_contentmanagement_status_by_id** — Get a status. (GET /api/v2/contentmanagement/status/{statusId}) The id is the statusId. Required: id.
- **list_all_genesys_cloud_contentmanagement_status** — Get a list of statuses for pending operations. (GET /api/v2/contentmanagement/status) Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_contentmanagement_usage** — Get usage details. (GET /api/v2/contentmanagement/usage)
- **list_all_genesys_cloud_contentmanagement_workspace_documents** — Get a list of documents. (GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents) Pages automatically with pageNumber/pageSize. Required: workspace_id.
- **delete_a_genesys_cloud_contentmanagement_workspace_member_by_id** — Delete a member from a workspace. (DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}) The id is the memberId. Required: id, workspace_id.
- **get_contentmanagement_workspace_member_by_id** — Get a workspace member. (GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}) The id is the memberId. Required: id, workspace_id.
- **list_all_genesys_cloud_contentmanagement_workspace_members** — Get a list workspace members. (GET /api/v2/contentmanagement/workspaces/{workspaceId}/members) Pages automatically with pageNumber/pageSize. Required: workspace_id.
- **update_a_genesys_cloud_contentmanagement_workspace_member_by_id** — Add a member to a workspace. (PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId}) The id is the memberId. Required: id, workspace_id, memberType.
- **create_a_genesys_cloud_contentmanagement_workspace_tagvalue** — Create a workspace tag. (POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues) Required: workspace_id, name.
- **delete_contentmanagement_workspace_tagvalue_by_id** — Delete workspace tag. Delete a tag from a workspace. Will remove this tag from all documents. (DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}) The id is the tagId. Required: id, workspace_id.
- **get_contentmanagement_workspace_tagvalue_by_id** — Get a workspace tag. (GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}) The id is the tagId. Required: id, workspace_id.
- **list_all_genesys_cloud_contentmanagement_workspace_tagvalues** — Get a list of workspace tags. (GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues) Pages automatically with pageNumber/pageSize. Required: workspace_id.
- **genesys_cloud_contentmanagement_workspace_tagvalues_search** — Perform a prefix query on tags in the workspace. (POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query) Required: workspace_id.
- **update_contentmanagement_workspace_tagvalue_by_id** — Update a workspace tag. Will update all documents with the new tag value. (PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}) The id is the tagId. Required: id, workspace_id, name.
- **create_a_genesys_cloud_contentmanagement_workspace** — Create a group workspace. (POST /api/v2/contentmanagement/workspaces) Required: name.
- **delete_a_genesys_cloud_contentmanagement_workspace_by_id** — Delete a workspace. (DELETE /api/v2/contentmanagement/workspaces/{workspaceId}) The id is the workspaceId. Required: id.
- **get_single_genesys_cloud_contentmanagement_workspace_by_id** — Get a workspace. (GET /api/v2/contentmanagement/workspaces/{workspaceId}) The id is the workspaceId. Required: id.
- **list_all_genesys_cloud_contentmanagement_workspaces** — Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to. (GET /api/v2/contentmanagement/workspaces) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_contentmanagement_workspace_by_id** — Update a workspace. (PUT /api/v2/contentmanagement/workspaces/{workspaceId}) The id is the workspaceId. Required: id, name.
- **conv_call_participant_comm_postflowaction_bulk_delete** — Remove mandatory post call actions. (DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/postflowaction) Requires permission conversation:call:deleteMandatoryPostFlowAction. Required: conversation_id, participant_id, communication_id.
- **conv_call_participant_comm_postflowaction_bulk_partial_update** — Set mandatory post call actions. If both values are null or blank error will occur. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/postflowaction) Requires permission conversation:call:setMandatoryPostFlowAction. Required: conversation_id, participant_id, communication_id.
- **conv_message_participant_parkingstate_bulk_partial_update** — Update conversation by setting its parking state. (PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/parkingstate) Requires permission conversation:message:park. Required: conversation_id, participant_id, state.
- **create_conv_messaging_integration_whatsapp_embeddedsignup** — Create a WhatsApp Integration using the WhatsApp embedded signup flow. Use the access token (Embedded Signup v2) or the OAuth code and session_info IDs (Embedded Signup v4) from the embedded signup flow. Creation is asynchronous; poll GET until createStatus is Completed. (POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup) Requires permission messaging:whatsappIntegration:add.
- **update_conv_messaging_integration_whatsapp_embeddedsignup_by_id** — Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow. Supply the two-step verification PIN. Embedded Signup v2: phoneNumber (E.164 from availablePhoneNumbers) and pin. Embedded Signup v4: pin and name are required; the name replaces the temporary name the backend assigned at creation with the desired integration name. Poll GET until status is Active. (PATCH /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId}) Requires permission messaging:integration:edit. The id is the integrationId. Required: id, pin.
- **conv_msg_intg_twitter_oauth_settings_by_intg_lookup** — Get twitter oauth settings to patch an integration. (GET /api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings) Requires permission messaging:XIntegration:add. Required: integration_id.
- **create_conv_participant_internalmessage_user_communication** — Setup internal message communication with user. The target user of the digital consultation must have the conversation:internalMessaging:accept permission. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications) Requires permission conversation:internalMessaging:setupWithUser. Required: conversation_id, participant_id, targetUserId.
- **update_conversation_aftercallwork_participant_communication** — Update after-call work for this conversation communication. (PATCH /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId}) Requires permission conversation:participant:wrapup. The id is the communicationId. Required: id, conversation_id, participant_id, afterCallWorkRequired.
- **create_a_genesys_cloud_conversation_barge** — Barge a conversation creating a barged in conference of connected participants. (POST /api/v2/conversations/{conversationId}/barge) Requires permission conversation:call:barge. Required: conversation_id.
- **genesys_cloud_conversation_call_conference_bulk_partial_update** — Update a conversation by merging in other conversations to create a conference. (PATCH /api/v2/conversations/calls/{conversationId}/conference) Requires permission conversation:conference:add. Required: conversation_id.
- **list_all_genesys_cloud_conversation_call_history** — Get call history. (GET /api/v2/conversations/calls/history) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_conversation_call_maximumconferenceparties_lookup** — Get the maximum number of participants that this user can have on a conference. (GET /api/v2/conversations/calls/maximumconferenceparties)
- **conversation_call_participant_attributes_bulk_partial_update** — Update the attributes on a conversation participant. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes) Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_call_participant_barge** — Barge a given participant's call creating a barged in conference of connected participants. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge) Requires permission conversation:call:barge. Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_call_participant_coach** — Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach) Requires permission conversation:call:coach. Required: conversation_id, participant_id.
- **create_conversation_call_participant_communication_summary** — Request an on-demand summary for a call communication. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/summaries) Requires permission conversation:summary:add. Required: conversation_id, participant_id, communication_id.
- **conversation_call_participant_communication_uuidata_bulk_update** — Set uuiData to be sent on future commands. (PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata) Required: conversation_id, participant_id, communication_id.
- **create_conversation_call_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_call_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **update_conversation_call_participant_communication_by_id** — Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}) The id is the communicationId. Required: id, conversation_id, participant_id.
- **genesys_cloud_conversation_call_participant_consult_bulk_delete** — Cancel the transfer. (DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult) Required: conversation_id, participant_id.
- **conversation_call_participant_consult_bulk_partial_update** — Change who can speak. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult) Required: conversation_id, participant_id, speakTo.
- **create_conversation_call_participant_consult_agent** — Initiate a consult transfer to an agent. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent) Requires any of permissions conversation:communication:consultTransfer, conversation:communication:consultTransferAgent. Required: conversation_id, participant_id, speakTo.
- **create_conversation_call_participant_consult_contact_external** — Initiate a consult transfer to an external contact. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external) Requires any of permissions conversation:communication:consultTransfer, conversation:communication:consultTransferExternalContact. Required: conversation_id, participant_id, speakTo, contactId, phoneType.
- **create_conversation_call_participant_consult_queue** — Initiate a consult transfer to a queue. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue) Requires any of permissions conversation:communication:consultTransfer, conversation:communication:consultTransferQueue. Required: conversation_id, participant_id, speakTo.
- **create_a_genesys_cloud_conversation_call_participant_monitor** — Listen in on the conversation from the point of view of a given participant. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor) Requires permission conversation:call:monitor. Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_call_participant_replace** — Replace this participant with the specified user and/or address. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace) Requires permission conversation:communication:blindTransfer. Required: conversation_id, participant_id.
- **create_conversation_call_participant_snippet_record** — Start/stop the snippet recording for a participant. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/snippet/record) Requires permission conversation:recording:snippetRecord. Required: conversation_id, participant_id, type.
- **create_a_genesys_cloud_conversation_call_participant_user** — Add participants to a conversation on behalf of a user. (POST /api/v2/conversations/calls/{conversationId}/participants/user/{userId}) Requires permission conversation:agentlessCall:add. Required: conversation_id, user_id, startTime, participants.
- **update_a_genesys_cloud_conversation_call_participant_user_by_id** — Update conversation participant on behalf of a user. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/user/{userId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect, conversation:agentlessCall:add. The id is the userId. Required: id, conversation_id, participant_id.
- **create_conversation_call_participant_voice_consult** — Initiate voice consult transfer. (POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/voice/consult) Requires permission conversation:communication:consultTransfer. Required: conversation_id, participant_id, speakTo.
- **genesys_cloud_conversation_call_participant_wrapup_lookup** — Get the wrap-up for this conversation participant. (GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup) Required: conversation_id, participant_id.
- **list_all_genesys_cloud_conversation_call_participant_wrapupcodes** — Get list of wrapup codes for this conversation participant. (GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes) Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_call_participant** — Add participants to a conversation. (POST /api/v2/conversations/calls/{conversationId}/participants) Required: conversation_id, startTime, participants.
- **update_a_genesys_cloud_conversation_call_participant_by_id** — Update conversation participant. (PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect. The id is the participantId. Required: id, conversation_id.
- **genesys_cloud_conversation_call_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/calls/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **create_a_genesys_cloud_conversation_call_user** — Create a call conversation on behalf of a user. (POST /api/v2/conversations/calls/user/{userId}) Requires any of permissions conversation:agentlessCall:add, conversation:call:add. Required: user_id.
- **create_a_genesys_cloud_conversation_callback_bulk_disconnect** — Disconnect multiple scheduled callbacks. (POST /api/v2/conversations/callbacks/bulk/disconnect) Requires permission conversation:communication:disconnect. Required: callbackDisconnectIdentifiers.
- **create_a_genesys_cloud_conversation_callback_bulk_update** — Update multiple scheduled callbacks. (POST /api/v2/conversations/callbacks/bulk/update) Requires permission conversation:callback:edit. Required: patchCallbackRequests.
- **conversation_callback_participant_attributes_bulk_partial_update** — Update the attributes on a conversation participant. (PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes) Required: conversation_id, participant_id.
- **create_conversation_callback_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_callback_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **update_conversation_callback_participant_communication_by_id** — Update conversation participant's communication by disconnecting it. (PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}) The id is the communicationId. Required: id, conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_callback_participant_replace** — Replace this participant with the specified user and/or address. (POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace) Requires permission conversation:communication:blindTransfer. Required: conversation_id, participant_id.
- **genesys_cloud_conversation_callback_participant_wrapup_lookup** — Get the wrap-up for this conversation participant. (GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup) Required: conversation_id, participant_id.
- **list_all_conversation_callback_participant_wrapupcodes** — Get list of wrapup codes for this conversation participant. (GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes) Required: conversation_id, participant_id.
- **update_a_genesys_cloud_conversation_callback_participant_by_id** — Update conversation participant. (PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect. The id is the participantId. Required: id, conversation_id.
- **genesys_cloud_conversation_callback_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **genesys_cloud_conversation_callbacks_bulk_partial_update** — Update a scheduled callback. (PATCH /api/v2/conversations/callbacks) Requires permission conversation:callback:edit. Required: conversationId, agentId.
- **create_a_genesys_cloud_conversation_callback** — Create a Callback. (POST /api/v2/conversations/callbacks) Requires permission conversation:callback:create. Required: callbackNumbers.
- **get_single_genesys_cloud_conversation_callback_by_id** — Get callback conversation. (GET /api/v2/conversations/callbacks/{conversationId}) The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_callbacks** — Get the logged-in user's active conversations and their Callback participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Callbacks? - Is the user directly participating in a Callback within that conversation?. (GET /api/v2/conversations/callbacks)
- **update_a_genesys_cloud_conversation_callback_by_id** — Update a conversation by disconnecting all of the participants. (PATCH /api/v2/conversations/callbacks/{conversationId}) Requires permission conversation:communication:disconnect. The id is the conversationId. Required: id.
- **create_a_genesys_cloud_conversation_call** — Create a call conversation. (POST /api/v2/conversations/calls) Requires permission conversation:conference:add.
- **get_single_genesys_cloud_conversation_call_by_id** — Get call conversation. (GET /api/v2/conversations/calls/{conversationId}) The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_calls** — Get the logged-in user's active conversations and their Call participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Calls? - Is the user directly participating in a Call within that conversation?. (GET /api/v2/conversations/calls)
- **update_a_genesys_cloud_conversation_call_by_id** — Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants. (PATCH /api/v2/conversations/calls/{conversationId}) Requires permission conversation:communication:disconnect. The id is the conversationId. Required: id.
- **create_a_genesys_cloud_conversation_calls_post** — Place a new call as part of a callback conversation. (POST /api/v2/conversations/calls/{conversationId}) Required: conversation_id, callNumber.
- **create_a_genesys_cloud_conversation_cobrowse** — Creates a cobrowse session. Requires "conversation:cobrowse:add" (for web messaging) or "conversation:cobrowsevoice:add" permission. (POST /api/v2/conversations/{conversationId}/cobrowse) Requires any of permissions conversation:cobrowse:add, conversation:cobrowseVoice:add. Required: conversation_id.
- **get_single_genesys_cloud_conversation_cobrowsesession_by_id** — Get cobrowse conversation. (GET /api/v2/conversations/cobrowsesessions/{conversationId}) The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_cobrowsesessions** — Get active cobrowse conversations for the logged in user. (GET /api/v2/conversations/cobrowsesessions)
- **create_conversation_communication_agentchecklist_agentaction** — API invoked to capture an agent action. (POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction) Requires permission conversation:agentchecklist:edit. Required: conversation_id, communication_id, agent_checklist_id, checklistItems.
- **create_conversation_communication_agentchecklist_finalize** — API invoked to finalize agent checklist evaluation. (POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize) Requires permission conversation:agentchecklist:edit. Required: conversation_id, communication_id, exitReason.
- **create_conversation_communication_agentchecklist_job** — Create inference job. (POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs) Requires permission conversation:agentchecklist:edit. Required: conversation_id, communication_id, agent_checklist_id, conversationContext.
- **get_conversation_communication_agentchecklist_job_by_id** — Get inference job status. (GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}) Requires permission conversation:agentchecklist:view. The id is the jobId. Required: id, conversation_id, communication_id, agent_checklist_id.
- **create_a_genesys_cloud_conversation_communication_agentchecklist** — Agent Checklist activation API. (POST /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}) Requires permission conversation:agentchecklist:edit. Required: conversation_id, communication_id, agent_checklist_id, activationTriggerType, language.
- **get_conversation_communication_agentchecklist_by_id** — Get checklist info for a single checklist. (GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}) Requires permission conversation:agentchecklist:view. The id is the agentChecklistId. Required: id, conversation_id, communication_id.
- **list_all_conversation_communication_agentchecklists** — Get information of all checklists associated with a conversation. (GET /api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists) Requires permission conversation:agentchecklist:view. Required: conversation_id, communication_id.
- **create_conversation_communication_internalmessage** — Send internal message. Send a new internal message for an existing communication. (POST /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages) Requires permission conversation:internalMessaging:create. Required: conversation_id, communication_id, text.
- **get_conversation_communication_internalmessage_by_id** — Get message. (GET /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId}) Requires permission conversation:internalMessaging:view. The id is the messageId. Required: id, conversation_id, communication_id.
- **list_all_conversation_communication_internalmessages** — Get messages for communication. (GET /api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages) Requires permission conversation:internalMessaging:view. Pages automatically with pageNumber/pageSize. Required: conversation_id, communication_id.
- **conversation_customattribute_bulk_bulk_partial_update** — Update a list of custom attributes record by amending the data with only the provided fields. (PATCH /api/v2/conversations/{conversationId}/customattributes/bulk) Requires permission conversation:customAttributes:edit. Required: conversation_id.
- **genesys_cloud_conversation_customattribute_bulk_bulk_update** — Create or update a list of custom attributes records. Updating replaces all data with the provided fields. (PUT /api/v2/conversations/{conversationId}/customattributes/bulk) Requires permission conversation:customAttributes:edit. Required: conversation_id.
- **get_conversation_customattribute_schema_coretype_by_id** — Get the core types from which all schemas are built. (GET /api/v2/conversations/customattributes/schemas/coretypes/{coreTypeName}) Requires permission conversation:customAttributes:schemaView. The id is the coreTypeName. Required: id.
- **list_all_conversation_customattribute_schema_coretypes** — Get the list of core types enabled for a specific namespace. (GET /api/v2/conversations/customattributes/schemas/coretypes) Requires permission conversation:customAttributes:schemaView.
- **genesys_cloud_conversation_customattribute_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/conversations/customattributes/schemas/limits) Requires permission conversation:customAttributes:schemaView.
- **get_conversation_customattribute_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/conversations/customattributes/schemas/{schemaId}/versions/{versionId}) Requires permission conversation:customAttributes:schemaView. The id is the versionId. Required: id, schema_id.
- **list_all_conversation_customattribute_schema_versions** — Get all versions of a CCA schema. (GET /api/v2/conversations/customattributes/schemas/{schemaId}/versions) Requires permission conversation:customAttributes:schemaView. Required: schema_id.
- **create_a_genesys_cloud_conversation_customattribute_schema** — Create a schema. (POST /api/v2/conversations/customattributes/schemas) Requires permission conversation:customAttributes:schemaAdd. Required: title, properties.
- **get_conversation_customattribute_schema_by_id** — Get a schema. (GET /api/v2/conversations/customattributes/schemas/{schemaId}) Requires permission conversation:customAttributes:schemaView. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_conversation_customattribute_schemas** — Get a list of schemas. (GET /api/v2/conversations/customattributes/schemas) Requires permission conversation:customAttributes:schemaView.
- **update_a_genesys_cloud_conversation_customattribute_schema_by_id** — Update a schema. (PUT /api/v2/conversations/customattributes/schemas/{schemaId}) Requires permission conversation:customAttributes:schemaEdit. The id is the schemaId. Required: id, version, enabled, jsonSchema.
- **genesys_cloud_conversation_customattributes_bulk_partial_update** — Update a single custom attributes record by amending the data with only the provided fields. (PATCH /api/v2/conversations/{conversationId}/customattributes) Requires permission conversation:customAttributes:edit. Required: conversation_id, id, customAttributes.
- **genesys_cloud_conversation_customattributes_bulk_update** — Create or update a single custom attributes record. Updating replaces all data with the provided fields. (PUT /api/v2/conversations/{conversationId}/customattributes) Requires permission conversation:customAttributes:edit. Required: conversation_id, id, customAttributes.
- **delete_a_genesys_cloud_conversation_customattribute_by_id** — Delete a custom attributes record. (DELETE /api/v2/conversations/{conversationId}/customattributes/{attributesId}) Requires permission conversation:customAttributes:delete. The id is the attributesId. Required: id, conversation_id.
- **get_single_genesys_cloud_conversation_customattribute_by_id** — Get custom attributes by id. (GET /api/v2/conversations/{conversationId}/customattributes/{attributesId}) Requires permission conversation:customAttributes:view. The id is the attributesId. Required: id, conversation_id.
- **list_all_genesys_cloud_conversation_customattributes** — Get a list of custom attributes for a conversation. (GET /api/v2/conversations/{conversationId}/customattributes) Requires permission conversation:customAttributes:view. Required: conversation_id.
- **genesys_cloud_conversation_customattributes_search** — Search resources. (POST /api/v2/conversations/customattributes/search) Requires permission conversation:customAttributes:view.
- **create_a_genesys_cloud_conversation_disconnect** — Performs a full conversation teardown. Issues disconnect requests for any connected media. (POST /api/v2/conversations/{conversationId}/disconnect) Requires permission conversation:communication:disconnect. Required: conversation_id.
- **create_a_genesys_cloud_conversation_email_agentless** — Create an email conversation, per API. (POST /api/v2/conversations/emails/agentless) Requires any of permissions conversation:email:create, conversation:agentlessEmail:send. Required: senderType, fromAddress, toAddresses.
- **create_a_genesys_cloud_conversation_email_inboundmessage** — Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. (POST /api/v2/conversations/emails/{conversationId}/inboundmessages) Required: conversation_id, provider.
- **conversation_email_message_draft_bulk_partial_update** — Reset conversation draft to its initial state and/or auto-fill draft content. (PATCH /api/v2/conversations/emails/{conversationId}/messages/draft) Required: conversation_id.
- **genesys_cloud_conversation_email_message_draft_bulk_update** — Update conversation draft reply. (PUT /api/v2/conversations/emails/{conversationId}/messages/draft) Required: conversation_id, to, from, textBody.
- **genesys_cloud_conversation_email_message_draft_lookup** — Get conversation draft reply. (GET /api/v2/conversations/emails/{conversationId}/messages/draft) Required: conversation_id.
- **create_conversation_email_message_draft_attachment_copy** — Copy attachments from an email message to the current draft. (POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy) Required: conversation_id, sourceMessage, attachments.
- **create_conversation_email_message_draft_attachment_upload** — Create a URL to upload a message attachment file. See https://developer.genesys.cloud/analyticsdatamanagement/uploads/upload-email-attachment-files for example usage. (POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/uploads) Requires permission conversation:emailAttachment:add. Required: conversation_id, name, contentLengthBytes.
- **delete_conversation_email_message_draft_attachment_by_id** — Delete attachment from draft. (DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}) The id is the attachmentId. Required: id, conversation_id.
- **create_a_genesys_cloud_conversation_email_message** — Send an email reply. (POST /api/v2/conversations/emails/{conversationId}/messages) Requires permission conversation:email:send. Required: conversation_id, to, from, textBody.
- **get_single_genesys_cloud_conversation_email_message_by_id** — Get conversation message. (GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}) The id is the messageId. Required: id, conversation_id.
- **list_all_genesys_cloud_conversation_email_messages** — Get conversation messages. (GET /api/v2/conversations/emails/{conversationId}/messages) Required: conversation_id.
- **conversation_email_participant_attributes_bulk_partial_update** — Update the attributes on a conversation participant. (PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes) Required: conversation_id, participant_id.
- **create_conversation_email_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_email_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **update_conversation_email_participant_communication_by_id** — Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. (PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}) The id is the communicationId. Required: id, conversation_id, participant_id.
- **conversation_email_participant_parkingstate_bulk_partial_update** — Update conversation by setting its parking state. (PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate) Requires permission conversation:email:park. Required: conversation_id, participant_id, state.
- **create_a_genesys_cloud_conversation_email_participant_replace** — Replace this participant with the specified user and/or address. (POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace) Requires permission conversation:communication:blindTransfer. Required: conversation_id, participant_id.
- **genesys_cloud_conversation_email_participant_wrapup_lookup** — Get the wrap-up for this conversation participant. (GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup) Required: conversation_id, participant_id.
- **list_all_conversation_email_participant_wrapupcodes** — Get list of wrapup codes for this conversation participant. (GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes) Required: conversation_id, participant_id.
- **update_a_genesys_cloud_conversation_email_participant_by_id** — Update conversation participant. (PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect, conversation:email:park. The id is the participantId. Required: id, conversation_id.
- **create_a_genesys_cloud_conversation_email_reconnect** — Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation. This request is not valid when using the Client Credentials OAuth grant. (POST /api/v2/conversations/emails/{conversationId}/reconnect) Requires permission conversation:communication:reconnect. Required: conversation_id.
- **genesys_cloud_conversation_email_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/emails/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **genesys_cloud_conversation_email_settings_lookup** — Get emails settings for a given conversation. (GET /api/v2/conversations/emails/{conversationId}/settings) Required: conversation_id.
- **create_a_genesys_cloud_conversation_email** — Create an email conversation. If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue. (POST /api/v2/conversations/emails) Requires permission conversation:email:create. Required: provider.
- **get_single_genesys_cloud_conversation_email_by_id** — Get email conversation. (GET /api/v2/conversations/emails/{conversationId}) The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_emails** — Get the logged-in user's active conversations and their Email participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Emails? - Is the user directly participating in an Email within that conversation?. (GET /api/v2/conversations/emails)
- **update_a_genesys_cloud_conversation_email_by_id** — Update a conversation by disconnecting all of the participants. (PATCH /api/v2/conversations/emails/{conversationId}) Requires permission conversation:communication:disconnect. The id is the conversationId. Required: id.
- **create_a_genesys_cloud_conversation_fax** — Create Fax Conversation. (POST /api/v2/conversations/faxes) Required: addresses.
- **get_single_genesys_cloud_conversation_internalmessage_by_id** — Get internal message conversation. (GET /api/v2/conversations/internalmessages/{conversationId}) Requires permission conversation:internalMessaging:view. The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_internalmessages** — Get the logged-in user's active conversations and their InternalMessage participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include InternalMessages? - Is the user directly participating in an InternalMessage within that conversation?. (GET /api/v2/conversations/internalmessages) Requires permission conversation:internalMessaging:view.
- **create_a_genesys_cloud_conversation_keyconfiguration_validate** — Validate encryption key configurations without saving it. (POST /api/v2/conversations/keyconfigurations/validate) Requires permission conversation:encryptionKey:edit. Required: url, keyConfigurationType.
- **create_a_genesys_cloud_conversation_keyconfiguration** — Setup configurations for encryption key creation. (POST /api/v2/conversations/keyconfigurations) Requires permission conversation:encryptionKey:edit. Required: url, keyConfigurationType.
- **get_single_genesys_cloud_conversation_keyconfiguration_by_id** — Get the encryption key configurations. (GET /api/v2/conversations/keyconfigurations/{keyconfigurationsId}) Requires permission conversation:encryptionKey:view. The id is the keyconfigurationsId. Required: id.
- **list_all_genesys_cloud_conversation_keyconfigurations** — Get a list of key configurations data. (GET /api/v2/conversations/keyconfigurations) Requires permission conversation:encryptionKey:view.
- **update_a_genesys_cloud_conversation_keyconfiguration_by_id** — Update the encryption key configurations. (PUT /api/v2/conversations/keyconfigurations/{keyconfigurationsId}) Requires permission conversation:encryptionKey:edit. The id is the keyconfigurationsId. Required: id, url, keyConfigurationType.
- **create_a_genesys_cloud_conversation_message_agentless** — Send an agentless outbound message. Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. (POST /api/v2/conversations/messages/agentless) Requires permission conversation:message:create. Required: fromAddress, toAddressMessengerType.
- **delete_a_genesys_cloud_conversation_message_cachedmedia_by_id** — Remove a cached media item asychronously. (DELETE /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}) Requires permission conversation:cachedMedia:delete. The id is the cachedMediaItemId. Required: id.
- **get_single_genesys_cloud_conversation_message_cachedmedia_by_id** — Get a cached media item. (GET /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}) Requires permission conversation:cachedMedia:view. The id is the cachedMediaItemId. Required: id.
- **list_all_genesys_cloud_conversation_message_cachedmedia** — Get a list of cached media items. (GET /api/v2/conversations/messages/cachedmedia) Requires permission conversation:cachedMedia:view. Pages automatically with pageNumber/pageSize.
- **get_conversation_message_communication_message_media_by_id** — Get media. See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage. (GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}) Requires any of permissions conversation:message:view, conversation:webmessaging:view. The id is the mediaId. Required: id, conversation_id, communication_id.
- **list_all_conversation_message_communication_message_media** — Get message media list by status. (GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media) Requires permission conversation:messageMedia:view. Pages automatically with pageNumber/pageSize. Required: conversation_id, communication_id.
- **create_conversation_message_communication_message_media_upload** — Create a URL to upload a message media file. See https://developer.genesys.cloud/commdigital/digital/messagemediaupload/ for example usage. (POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/uploads) Requires any of permissions conversation:message:create, conversation:webmessaging:create, conversation:socialmedia:create. Required: conversation_id, communication_id, fileName, contentLengthBytes.
- **create_conversation_message_communication_message** — Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, or 1 messageTemplate. (POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages) Requires any of permissions conversation:message:create, conversation:webmessaging:create. Required: conversation_id, communication_id, textBody.
- **create_conversation_message_communication_socialmedia_message** — Send a social media message on existing conversation/communication. (POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages) Requires permission conversation:socialmedia:create. Required: conversation_id, communication_id, inReplyToMessageId.
- **create_a_genesys_cloud_conversation_message_communication_typing** — Send message typing event for existing conversation/communication. (POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing) Requires any of permissions conversation:message:create, conversation:webmessaging:create. Required: conversation_id, communication_id, typing.
- **genesys_cloud_conversation_message_details_lookup** — Get message. (GET /api/v2/conversations/messages/{messageId}/details) Requires any of permissions conversation:message:view, conversation:webmessaging:view. Required: message_id.
- **create_a_genesys_cloud_conversation_message_inbound_open_event** — Send an inbound Open Event Message. Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. (POST /api/v2/conversations/messages/{integrationId}/inbound/open/event) Requires permission conversation:message:receive. Required: integration_id, channel, events.
- **create_a_genesys_cloud_conversation_message_inbound_open_message** — Send inbound Open Message. Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. (POST /api/v2/conversations/messages/{integrationId}/inbound/open/message) Requires permission conversation:message:receive. Required: integration_id, channel.
- **create_a_genesys_cloud_conversation_message_inbound_open_receipt** — Send an inbound Open Receipt Message. Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. (POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt) Requires permission conversation:message:receive. Required: integration_id, id, channel, status.
- **create_conversation_message_inbound_open_structured_response** — Send inbound Open Response. Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. (POST /api/v2/conversations/messages/{integrationId}/inbound/open/structured/response) Requires permission conversation:message:receive. Required: integration_id, channel, buttonResponse, originatingMessageId.
- **create_a_genesys_cloud_conversation_message_message_bulk** — Get messages in batch. The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. The max messages you can request in the body is 1,000. (POST /api/v2/conversations/messages/{conversationId}/messages/bulk) Requires any of permissions conversation:message:view, conversation:webmessaging:view. Required: conversation_id.
- **get_single_genesys_cloud_conversation_message_message_by_id** — Get conversation message. (GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}) Requires any of permissions conversation:message:view, conversation:webmessaging:view. The id is the messageId. Required: id, conversation_id.
- **conversation_message_participant_attributes_bulk_partial_update** — Update the attributes on a conversation participant. (PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes) Required: conversation_id, participant_id.
- **create_conversation_message_participant_communication_summary** — Request an on-demand summary for a message communication. (POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/summaries) Requires permission conversation:summary:add. Required: conversation_id, participant_id, communication_id.
- **create_conversation_message_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_message_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **update_conversation_message_participant_communication_by_id** — Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup. (PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}) The id is the communicationId. Required: id, conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_message_participant_monitor** — Listen in on the conversation from the point of view of a given participant. (POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor) Requires permission conversation:message:monitor. Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_message_participant_replace** — Replace this participant with the specified user and/or address. (POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace) Requires permission conversation:communication:blindTransfer. Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_message_participant_takeover** — The User performing this action will takeover the conversation from the participant specified. This operation allows a user performing the action to take over a conversation from the participant specified. The user must be monitoring the participant and must have the necessary permissions to perform the takeover action. (POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/takeover) Requires permission conversation:message:takeover. Required: conversation_id, participant_id.
- **genesys_cloud_conversation_message_participant_wrapup_lookup** — Get the wrap-up for this conversation participant. (GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup) Required: conversation_id, participant_id.
- **list_all_conversation_message_participant_wrapupcodes** — Get list of wrapup codes for this conversation participant. (GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes) Required: conversation_id, participant_id.
- **update_a_genesys_cloud_conversation_message_participant_by_id** — Update conversation participant. (PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect. The id is the participantId. Required: id, conversation_id.
- **genesys_cloud_conversation_message_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/messages/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **create_a_genesys_cloud_conversation_message** — Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. (POST /api/v2/conversations/messages) Requires permission conversation:message:create. Required: queueId, toAddress, toAddressMessengerType.
- **get_single_genesys_cloud_conversation_message_by_id** — Get message conversation. (GET /api/v2/conversations/messages/{conversationId}) The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_messages** — Get the logged-in user's active conversations and their Message participants state. This endpoint answers three questions:- Is the user involved in any active conversation? - Does that active conversation include Messages? - Is the user directly participating in a Message within that conversation?. (GET /api/v2/conversations/messages)
- **update_a_genesys_cloud_conversation_message_by_id** — Update a conversation by disconnecting all of the participants. (PATCH /api/v2/conversations/messages/{conversationId}) Requires any of permissions conversation:communication:disconnect, conversation:message:park. The id is the conversationId. Required: id.
- **genesys_cloud_conversation_messaging_facebook_app_lookup** — Get Genesys Facebook App Id. (GET /api/v2/conversations/messaging/facebook/app) Requires permission messaging:integration:add.
- **list_all_conversation_messaging_facebook_permissions** — Get a list of Facebook Permissions. (GET /api/v2/conversations/messaging/facebook/permissions) Requires any of permissions messaging:integration:add, messaging:integration:edit, messaging:conversationInstagramIntegration:add.
- **get_conversation_messaging_idresolution_integration_apple_by_id** — Get Apple messaging integration identity resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionApple:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_apple** — Create an identity resolution settings for a Apple messaging integration. (PUT /api/v2/conversations/messaging/identityresolution/integrations/apple/{integrationId}) Requires permissions messaging:integration:edit, messaging:identityResolutionApple:edit. The id is the integrationId. Required: id, resolveIdentities.
- **get_conversation_messaging_idresolution_integration_facebook** — Get Facebook messaging integration identity resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionFacebook:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_facebook** — Create an identity resolution settings for a Facebook messaging integration. (PUT /api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}) Requires permissions messaging:integration:edit, messaging:identityResolutionFacebook:edit. The id is the integrationId. Required: id, resolveIdentities.
- **get_conversation_messaging_idresolution_integration_instagram** — Get an Instagram integration identity resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionInstagram:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_instagram** — Create identity resolution settings for an Instagram messaging integration. (PUT /api/v2/conversations/messaging/identityresolution/integrations/instagram/{integrationId}) Requires permissions messaging:integration:edit, messaging:identityResolutionInstagram:edit. The id is the integrationId. Required: id, resolveIdentities.
- **get_conversation_messaging_idresolution_integration_open_by_id** — Get an open messaging integration Identity Resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionOpen:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_open** — Update an open messaging integration Identity Resolution settings. (PUT /api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}) Requires permissions messaging:integration:edit, messaging:identityResolutionOpen:edit. The id is the integrationId. Required: id, resolveIdentities.
- **get_conversation_messaging_idresolution_integration_twitter** — Get X (Formally Twitter) messaging integration identity resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionX:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_twitter** — Create an identity resolution settings for an X (Formally Twitter) messaging integration. (PUT /api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}) Requires permissions messaging:XIntegration:edit, messaging:identityResolutionX:edit. The id is the integrationId. Required: id, resolveIdentities.
- **get_conversation_messaging_idresolution_integration_whatsapp** — Get a whatsApp integration Identity Resolution settings. (GET /api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}) Requires permissions messaging:integration:view, messaging:identityResolutionWhatsApp:view. The id is the integrationId. Required: id.
- **update_conversation_messaging_idresolution_integration_whatsapp** — Update a whatsApp integration Identity Resolution settings. (PUT /api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}) Requires permissions messaging:integration:edit, messaging:identityResolutionWhatsApp:edit. The id is the integrationId. Required: id, resolveIdentities.
- **create_a_genesys_cloud_conversation_messaging_integration_apple** — Create Apple Integration. (POST /api/v2/conversations/messaging/integrations/apple) Requires permission messaging:appleIntegration:add. Required: name, messagesForBusinessId.
- **delete_conversation_messaging_integration_apple_by_id** — Delete an Apple messaging integration. (DELETE /api/v2/conversations/messaging/integrations/apple/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_apple_by_id** — Get an Apple messaging integration. (GET /api/v2/conversations/messaging/integrations/apple/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_genesys_cloud_conversation_messaging_integration_apple** — Get a list of Apple Integrations. (GET /api/v2/conversations/messaging/integrations/apple) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_apple_by_id** — Update an Apple messaging integration. (PATCH /api/v2/conversations/messaging/integrations/apple/{integrationId}) Requires permission messaging:appleIntegration:edit. The id is the integrationId. Required: id.
- **create_conversation_messaging_integration_facebook** — Create a Facebook Integration. (POST /api/v2/conversations/messaging/integrations/facebook) Requires permission messaging:integration:add. Required: name.
- **delete_conversation_messaging_integration_facebook_by_id** — Delete a Facebook messaging integration. (DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_facebook_by_id** — Get a Facebook messaging integration. (GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_conversation_messaging_integration_facebook** — Get a list of Facebook Integrations. (GET /api/v2/conversations/messaging/integrations/facebook) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_facebook_by_id** — Update Facebook messaging integration. (PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId}) Requires permission messaging:integration:edit. The id is the integrationId. Required: id.
- **create_conversation_messaging_integration_instagram** — Create Instagram Integration. (POST /api/v2/conversations/messaging/integrations/instagram) Requires permission messaging:conversationInstagramIntegration:add. Required: name.
- **delete_conversation_messaging_integration_instagram_by_id** — Delete Instagram messaging integration. (DELETE /api/v2/conversations/messaging/integrations/instagram/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_instagram_by_id** — Get Instagram messaging integration. (GET /api/v2/conversations/messaging/integrations/instagram/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_conversation_messaging_integration_instagram** — Get a list of Instagram Integrations. (GET /api/v2/conversations/messaging/integrations/instagram) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_instagram_by_id** — Update Instagram messaging integration. (PATCH /api/v2/conversations/messaging/integrations/instagram/{integrationId}) Requires permission messaging:integration:edit. The id is the integrationId. Required: id.
- **create_a_genesys_cloud_conversation_messaging_integration_open** — Create an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. (POST /api/v2/conversations/messaging/integrations/open) Requires permission messaging:integration:add. Required: name, outboundNotificationWebhookUrl, outboundNotificationWebhookSignatureSecretToken.
- **delete_conversation_messaging_integration_open_by_id** — Delete an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. (DELETE /api/v2/conversations/messaging/integrations/open/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_open_by_id** — Get an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. (GET /api/v2/conversations/messaging/integrations/open/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_genesys_cloud_conversation_messaging_integration_open** — Get a list of Open messaging integrations. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. (GET /api/v2/conversations/messaging/integrations/open) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_open_by_id** — Update an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information. (PATCH /api/v2/conversations/messaging/integrations/open/{integrationId}) Requires permission messaging:integration:edit. The id is the integrationId. Required: id, name.
- **create_conversation_messaging_integration_twitter** — Create Twitter Integration. (POST /api/v2/conversations/messaging/integrations/twitter) Requires permission messaging:XIntegration:add. Required: name, signupCode, appId, codeChallenge, redirectUri.
- **delete_conversation_messaging_integration_twitter_by_id** — Delete Twitter messaging integration. (DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_twitter_by_id** — Get Twitter messaging integration. (GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_conversation_messaging_integration_twitter** — Get a list of Twitter Integrations. (GET /api/v2/conversations/messaging/integrations/twitter) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_twitter_by_id** — Update a Twitter messaging integration. (PATCH /api/v2/conversations/messaging/integrations/twitter/{integrationId}) Requires permission messaging:XIntegration:edit. The id is the integrationId. Required: id.
- **conversation_messaging_integration_twitter_oauth_settings_lookup** — Get twitter oauth settings. (GET /api/v2/conversations/messaging/integrations/twitter/oauth/settings) Requires permission messaging:XIntegration:add.
- **delete_conversation_messaging_integration_whatsapp_by_id** — Delete a WhatsApp messaging integration. (DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}) Requires permission messaging:integration:delete. The id is the integrationId. Required: id.
- **get_conversation_messaging_integration_whatsapp_by_id** — Get a WhatsApp messaging integration. (GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}) Requires permission messaging:integration:view. The id is the integrationId. Required: id.
- **list_all_conversation_messaging_integration_whatsapp** — Get a list of WhatsApp Integrations. (GET /api/v2/conversations/messaging/integrations/whatsapp) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_integration_whatsapp_by_id** — Update a WhatsApp messaging integration. (PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}) Requires permission messaging:integration:edit. The id is the integrationId. Required: id.
- **list_all_genesys_cloud_conversation_messaging_integrations** — Get a list of Integrations. (GET /api/v2/conversations/messaging/integrations) Requires permission messaging:integration:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_conversation_messaging_setting** — Create a messaging setting. (POST /api/v2/conversations/messaging/settings) Requires permission messaging:setting:add. Required: name.
- **delete_a_genesys_cloud_conversation_messaging_setting_by_id** — Delete a messaging setting. (DELETE /api/v2/conversations/messaging/settings/{messageSettingId}) Requires permission messaging:setting:delete. The id is the messageSettingId. Required: id.
- **get_single_genesys_cloud_conversation_messaging_setting_by_id** — Get a messaging setting. (GET /api/v2/conversations/messaging/settings/{messageSettingId}) Requires permission messaging:setting:view. The id is the messageSettingId. Required: id.
- **list_all_genesys_cloud_conversation_messaging_settings** — Get a list of messaging settings. (GET /api/v2/conversations/messaging/settings) Requires permission messaging:setting:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_conversation_messaging_setting_by_id** — Update a messaging setting. (PATCH /api/v2/conversations/messaging/settings/{messageSettingId}) Requires permission messaging:setting:edit. The id is the messageSettingId. Required: id.
- **conversation_messaging_settings_default_bulk_delete** — Delete the organization's default setting, a global default will be applied to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it. (DELETE /api/v2/conversations/messaging/settings/default) Requires permission messaging:setting:delete.
- **conversation_messaging_settings_default_bulk_update** — Set the organization's default setting that may be applied to to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it. (PUT /api/v2/conversations/messaging/settings/default) Requires permission messaging:setting:edit. Required: settingId.
- **genesys_cloud_conversation_messaging_settings_default_lookup** — Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it. (GET /api/v2/conversations/messaging/settings/default) Requires permission messaging:setting:view.
- **create_a_genesys_cloud_conversation_messaging_supportedcontent** — Create a Supported Content profile. (POST /api/v2/conversations/messaging/supportedcontent) Requires permission messaging:supportedContent:add. Required: name.
- **delete_conversation_messaging_supportedcontent_by_id** — Delete a supported content profile. (DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId}) Requires permission messaging:supportedContent:delete. The id is the supportedContentId. Required: id.
- **get_conversation_messaging_supportedcontent_by_id** — Get a supported content profile. (GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId}) Requires permission messaging:supportedContent:view. The id is the supportedContentId. Required: id.
- **list_all_genesys_cloud_conversation_messaging_supportedcontent** — Get a list of Supported Content profiles. (GET /api/v2/conversations/messaging/supportedcontent) Requires permission messaging:supportedContent:view. Pages automatically with pageNumber/pageSize.
- **update_conversation_messaging_supportedcontent_by_id** — Update a supported content profile. (PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId}) Requires permission messaging:supportedContent:edit. The id is the supportedContentId. Required: id.
- **conversation_messaging_supportedcontent_default_bulk_update** — Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it. (PUT /api/v2/conversations/messaging/supportedcontent/default) Requires permission messaging:supportedContent:edit. Required: id.
- **conversation_messaging_supportedcontent_default_lookup** — Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it. (GET /api/v2/conversations/messaging/supportedcontent/default) Requires permission messaging:supportedContent:view.
- **conversation_messaging_threadingtimeline_bulk_update** — Update conversation threading window timeline for each messaging type. PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. (PUT /api/v2/conversations/messaging/threadingtimeline) Requires permission conversation:threadingTimeline:edit. Required: settings.
- **genesys_cloud_conversation_messaging_threadingtimeline_lookup** — Get conversation threading window timeline for each messaging type. Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. (GET /api/v2/conversations/messaging/threadingtimeline) Requires permission conversation:threadingTimeline:view.
- **conversation_participant_attributes_bulk_partial_update** — Update the attributes on a conversation participant. (PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes) Required: conversation_id, participant_id.
- **genesys_cloud_conversation_participant_attributes_search** — Search conversations. (POST /api/v2/conversations/participants/attributes/search) Requires permission conversation:participant:attributesview.
- **create_a_genesys_cloud_conversation_participant_callback** — Create a new callback for the specified participant on the conversation. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks) Requires permission conversation:callback:create. Required: conversation_id, participant_id, callbackNumbers.
- **delete_a_genesys_cloud_conversation_participant_code_by_id** — Delete a code used to add a communication to this participant. (DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}) The id is the addCommunicationCode. Required: id, conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_participant_digit** — Sends DTMF to the participant. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits) Required: conversation_id, participant_id.
- **genesys_cloud_conversation_participant_flaggedreason_bulk_delete** — Remove flagged reason from conversation participant. (DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason) Required: conversation_id, participant_id.
- **genesys_cloud_conversation_participant_flaggedreason_bulk_update** — Set flagged reason on conversation participant to indicate bad conversation quality. (PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason) Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_participant_replace_agent** — Replace this participant with the specified agent. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent) Requires any of permissions conversation:communication:blindTransfer, conversation:communication:blindTransferAgent. Required: conversation_id, participant_id.
- **create_conversation_participant_replace_contact_external** — Replace this participant with the an external contact. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external) Requires any of permissions conversation:communication:blindTransfer, conversation:communication:blindTransferExternalContact. Required: conversation_id, participant_id, contactId, phoneType.
- **create_a_genesys_cloud_conversation_participant_replace_queue** — Replace this participant with the specified queue. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue) Requires any of permissions conversation:communication:blindTransfer, conversation:communication:blindTransferQueue. Required: conversation_id, participant_id.
- **create_conversation_participant_screenmonitor_session** — Start a conversation-level screen monitoring session. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions) Requires permission realtimeMonitor:screen:monitorConversation. Required: conversation_id, participant_id.
- **delete_conversation_participant_screenmonitor_session_by_id** — Stop a conversation-level screen monitoring session. (DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}) Requires permission realtimeMonitor:screen:monitorConversation. The id is the screenMonitoringId. Required: id, conversation_id, participant_id.
- **get_conversation_participant_screenmonitor_session_by_id** — Get a conversation-level screen monitoring session object using the supplied screenMonitoringId. (GET /api/v2/conversations/{conversationId}/participants/{participantId}/screenmonitors/sessions/{screenMonitoringId}) Requires permission realtimeMonitor:screen:monitorConversation. The id is the screenMonitoringId. Required: id, conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_participant_secureivrsession** — Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions) Required: conversation_id, participant_id, flowId, userData.
- **get_conversation_participant_secureivrsession_by_id** — Fetch info on a secure session. (GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}) The id is the secureSessionId. Required: id, conversation_id, participant_id.
- **list_all_conversation_participant_secureivrsessions** — Get a list of secure sessions for this participant. (GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions) Required: conversation_id, participant_id.
- **create_a_genesys_cloud_conversation_participant_transfer** — Replace this participant by another one using the address of the destination. (POST /api/v2/conversations/{conversationId}/participants/{participantId}/transfer) Requires permission conversation:communication:blindTransfer. Required: conversation_id, participant_id.
- **genesys_cloud_conversation_participant_wrapup_lookup** — Get the wrap-up for this conversation participant. (GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup) Required: conversation_id, participant_id.
- **list_all_genesys_cloud_conversation_participant_wrapupcodes** — Get list of wrapup codes for this conversation participant. (GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes) Required: conversation_id, participant_id.
- **update_a_genesys_cloud_conversation_participant_by_id** — Update a participant. Update conversation participant. (PATCH /api/v2/conversations/{conversationId}/participants/{participantId}) Requires any of permissions conversation:participant:wrapup, conversation:call:record, conversation:communication:disconnect. The id is the participantId. Required: id, conversation_id.
- **create_a_genesys_cloud_conversation_recording_annotation** — Create annotation. If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates. (POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations) Requires any of permissions recording:annotation:add, recording:annotation:edit, recording:recording:view, recording:recordingSegment:view …. Required: conversation_id, recording_id.
- **delete_a_genesys_cloud_conversation_recording_annotation_by_id** — Delete annotation. (DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}) Requires any of permissions recording:annotation:delete, recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view …. The id is the annotationId. Required: id, conversation_id, recording_id.
- **get_single_genesys_cloud_conversation_recording_annotation_by_id** — Get annotation. (GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}) Requires any of permissions recording:annotation:view, recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view …. The id is the annotationId. Required: id, conversation_id, recording_id.
- **list_all_genesys_cloud_conversation_recording_annotations** — Get annotations for recording. (GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations) Requires any of permissions recording:annotation:view, recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view …. Required: conversation_id, recording_id.
- **update_a_genesys_cloud_conversation_recording_annotation_by_id** — Update annotation. If the annotation does not exist on the recording, it is created. If it already exists, it is updated. The recording:annotation:add permission is required for creates, and recording:annotation:edit is required for updates. (PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}) Requires any of permissions recording:annotation:edit, recording:annotation:add, recording:recording:view, recording:recordingSegment:view …. The id is the annotationId. Required: id, conversation_id, recording_id.
- **get_single_genesys_cloud_conversation_recordingmetadatum_by_id** — Get metadata for a specific recording. Does not return playable media. (GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}) Requires any of permissions recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view, recording:screenRecording:view. The id is the recordingId. Required: id, conversation_id.
- **list_all_genesys_cloud_conversation_recordingmetadata** — Get recording metadata for a conversation. Does not return playable media nor system annotations. (GET /api/v2/conversations/{conversationId}/recordingmetadata) Requires any of permissions recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view, recording:screenRecording:view. Required: conversation_id.
- **get_single_genesys_cloud_conversation_recording_by_id** — Gets a specific recording. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted. (GET /api/v2/conversations/{conversationId}/recordings/{recordingId}) Requires any of permissions recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view, recording:screenRecording:view. The id is the recordingId. Required: id, conversation_id.
- **list_all_genesys_cloud_conversation_recordings** — Get all of a Conversation's Recordings. Bookmark annotations will be excluded if recording:annotation:view permission is missing. If the recording:recording:viewSensitiveData permission is missing and the organization has sensitive data redaction enabled, recordings with sensitive data will be redacted. (GET /api/v2/conversations/{conversationId}/recordings) Requires any of permissions recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view, recording:screenRecording:view. Required: conversation_id.
- **update_a_genesys_cloud_conversation_recording_by_id** — Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. (PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}) Requires any of permissions recording:recording:view, recording:recording:editRetention, recording:recording:restore, recording:screenRecording:view …. The id is the recordingId. Required: id, conversation_id.
- **genesys_cloud_conversation_recordingstate_bulk_partial_update** — Update a conversation by setting its recording state. (PATCH /api/v2/conversations/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **get_single_genesys_cloud_conversation_screenmonitor_by_id** — Get screen monitoring conversation. (GET /api/v2/conversations/screenmonitors/{conversationId}) Requires permission conversation:screenMonitor:view. The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversation_screenmonitors** — Get active screen monitoring conversations for the logged in user. (GET /api/v2/conversations/screenmonitors) Requires permission conversation:screenMonitor:view.
- **genesys_cloud_conversation_secureattributes_bulk_partial_update** — Update the secure attributes on a conversation. (PATCH /api/v2/conversations/{conversationId}/secureattributes) Requires permission conversation:participant:attributesedit. Required: conversation_id.
- **genesys_cloud_conversation_secureattributes_bulk_update** — Set the secure attributes on a conversation. (PUT /api/v2/conversations/{conversationId}/secureattributes) Requires permission conversation:participant:attributesedit. Required: conversation_id.
- **genesys_cloud_conversation_secureattributes_lookup** — Get the secure attributes on a conversation. (GET /api/v2/conversations/{conversationId}/secureattributes) Requires permission conversation:participant:attributesview. Required: conversation_id.
- **genesys_cloud_conversation_settings_bulk_partial_update** — Update Settings. (PATCH /api/v2/conversations/settings) Requires permission conversation:settings:edit.
- **genesys_cloud_conversation_settings_lookup** — Get Settings. (GET /api/v2/conversations/settings) Requires permission conversation:settings:view.
- **create_conversation_social_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_social_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **genesys_cloud_conversation_social_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/socials/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **create_a_genesys_cloud_conversation_suggestion_engagement** — Save an engagement on the suggestion. (POST /api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement) Requires permission conversation:suggestionEngagement:add. Required: conversation_id, suggestion_id, engagementType.
- **get_single_genesys_cloud_conversation_suggestion_by_id** — Get Suggestion. (GET /api/v2/conversations/{conversationId}/suggestions/{suggestionId}) Requires permission conversation:suggestion:view. The id is the suggestionId. Required: id, conversation_id.
- **list_all_genesys_cloud_conversation_suggestions** — Get all suggestions for a conversation. (GET /api/v2/conversations/{conversationId}/suggestions) Requires permission conversation:suggestion:view. Pages automatically: pass the returned next_cursor to get the next page. Required: conversation_id.
- **update_a_genesys_cloud_conversation_suggestion_by_id** — Update a suggestion. (PATCH /api/v2/conversations/{conversationId}/suggestions/{suggestionId}) Requires permission conversation:suggestion:edit. The id is the suggestionId. Required: id, conversation_id.
- **genesys_cloud_conversation_summaries_lookup** — Get the summaries of the conversation. (GET /api/v2/conversations/{conversationId}/summaries) Requires permission conversation:summary:view. Required: conversation_id.
- **genesys_cloud_conversation_summaries_preview** — Trigger summary preview event generation. (POST /api/v2/conversations/summaries/preview) Requires permission aiStudio:summaryPreview:view. Required: transcript, summaryPreviewSessionId, summarySetting.
- **conversation_summary_engagements_bulk_partial_update** — Update agent's engagement for the summary. (PATCH /api/v2/conversations/{conversationId}/summaries/{summaryId}/engagements) Requires permission conversation:summaryEngagement:edit. Required: conversation_id, summary_id.
- **genesys_cloud_conversation_summary_feedback_bulk_partial_update** — Update the feedback for the summary. (PATCH /api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback) Requires permission conversation:summaryFeedback:edit. Required: conversation_id, summary_id.
- **create_a_genesys_cloud_conversation_summary_feedback** — Submit feedback for the summary. (POST /api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback) Requires permission conversation:summaryFeedback:add. Required: conversation_id, summary_id, summary.
- **create_a_genesys_cloud_conversation_summary_setting** — Create a summary setting. (POST /api/v2/conversations/summaries/settings) Requires permission aiStudio:summaryConfig:add. Required: name, language.
- **delete_a_genesys_cloud_conversation_summary_setting_by_id** — Delete a summary setting. (DELETE /api/v2/conversations/summaries/settings/{summarySettingId}) Requires permission aiStudio:summaryConfig:delete. The id is the summarySettingId. Required: id.
- **get_single_genesys_cloud_conversation_summary_setting_by_id** — Receive a summary setting. (GET /api/v2/conversations/summaries/settings/{summarySettingId}) Requires permission aiStudio:summaryConfig:view. The id is the summarySettingId. Required: id.
- **list_all_genesys_cloud_conversation_summary_settings** — Get all summary settings. (GET /api/v2/conversations/summaries/settings) Requires permission aiStudio:summaryConfig:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_conversation_summary_setting_by_id** — Update a summary setting. (PUT /api/v2/conversations/summaries/settings/{summarySettingId}) Requires permission aiStudio:summaryConfig:edit. The id is the summarySettingId. Required: id, name, language.
- **genesys_cloud_conversation_tags_bulk_update** — Update the tags on a conversation. (PUT /api/v2/conversations/{conversationId}/tags) Requires permission conversation:externalTag:edit. Required: conversation_id, externalTag.
- **genesys_cloud_conversation_utilizationlabel_bulk_partial_update** — Update the utilization label on a conversation. When there is no value provided, the system default label is applied. (PATCH /api/v2/conversations/{conversationId}/utilizationlabel) Requires permission conversation:utilizationLabel:edit. Required: conversation_id.
- **create_a_genesys_cloud_conversation_video_meeting** — Generate a meetingId for a given conferenceId. (POST /api/v2/conversations/videos/meetings) Requires permission video:video:access. Required: ephemeral.
- **get_single_genesys_cloud_conversation_video_meeting_by_id** — Gets a record for a given meetingId. (GET /api/v2/conversations/videos/meetings/{meetingId}) Requires permission video:video:access. The id is the meetingId. Required: id.
- **create_conversation_video_participant_communication_wrapup** — Apply wrap-up for this conversation communication. (POST /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Requires permission conversation:participant:wrapup. Required: conversation_id, participant_id, communication_id.
- **conversation_video_participant_communication_wrapup_lookup** — Get the wrap-up for this conversation communication. (GET /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup) Required: conversation_id, participant_id, communication_id.
- **genesys_cloud_conversation_video_recordingstate_bulk_update** — Update a conversation by setting its recording state. (PUT /api/v2/conversations/videos/{conversationId}/recordingstate) Requires permission conversation:recording:pauseOthers. Required: conversation_id.
- **genesys_cloud_conversations_assign** — Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages. (POST /api/v2/conversations/{conversationId}/assign) Requires any of permissions conversation:call:pull, conversation:call:assign, conversation:callback:pull, conversation:callback:assign …. Required: conversation_id, id.
- **delete_a_genesys_cloud_conversation_by_id** — Update a conversation by disconnecting all of the participants. (DELETE /api/v2/conversations/{conversationId}) Requires permission conversation:communication:disconnect. The id is the conversationId. Required: id.
- **get_single_genesys_cloud_conversation_by_id** — Get conversation. (GET /api/v2/conversations/{conversationId}) Requires permission conversation:communication:view. The id is the conversationId. Required: id.
- **list_all_genesys_cloud_conversations** — Get active conversations for the logged in user. (GET /api/v2/conversations)
- **get_single_genesys_cloud_dataextension_coretype_by_id** — Get a specific named core type. (GET /api/v2/dataextensions/coretypes/{coretypeName}) Requires permission externalContacts:customFields:view. The id is the coretypeName. Required: id.
- **list_all_genesys_cloud_dataextension_coretypes** — Get the core types from which all schemas are built. (GET /api/v2/dataextensions/coretypes) Requires permission externalContacts:customFields:view.
- **genesys_cloud_dataextension_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/dataextensions/limits) Requires permission externalContacts:customFields:view.
- **create_a_genesys_cloud_dataprivacy_maskingrule_validate** — Validate masking before creating. (POST /api/v2/dataprivacy/maskingrules/validate) Requires permission dataprivacy:maskingrule:execute. Required: text, definition.
- **create_a_genesys_cloud_dataprivacy_maskingrule** — Create a new masking rule resource. (POST /api/v2/dataprivacy/maskingrules) Requires permission dataprivacy:maskingrule:add. Required: name, substituteCharacter, definition, enabled, type.
- **delete_a_genesys_cloud_dataprivacy_maskingrule_by_id** — Delete a masking rule. (DELETE /api/v2/dataprivacy/maskingrules/{ruleId}) Requires permission dataprivacy:maskingrule:delete. The id is the ruleId. Required: id.
- **get_single_genesys_cloud_dataprivacy_maskingrule_by_id** — Fetch details about a masking rule. (GET /api/v2/dataprivacy/maskingrules/{ruleId}) Requires permission dataprivacy:maskingrule:view. The id is the ruleId. Required: id.
- **list_all_genesys_cloud_dataprivacy_maskingrules** — Retrieve the list of masking rules. (GET /api/v2/dataprivacy/maskingrules) Requires permission dataprivacy:maskingrule:view.
- **update_a_genesys_cloud_dataprivacy_maskingrule_by_id** — Update information about a masking rule. (PATCH /api/v2/dataprivacy/maskingrules/{ruleId}) Requires permission dataprivacy:maskingrule:edit. The id is the ruleId. Required: id.
- **genesys_cloud_date_lookup** — Get the current system date/time. (GET /api/v2/date)
- **list_all_genesys_cloud_dependency_type_id_connection_requiredby** — Get entities that require the given entity. (GET /api/v2/dependencies/type/{entityType}/id/{entityId}/connections/requiredby) Requires permission dependencies:dependency:view. Required: entity_type, entity_id.
- **dependency_type_id_connection_requiredbycounts_lookup** — An estimated count of entities that depend on this entity, including indirect dependencies. (GET /api/v2/dependencies/type/{entityType}/id/{entityId}/connections/requiredbycounts) Requires permission dependencies:dependency:view. Required: entity_type, entity_id.
- **list_all_genesys_cloud_dependency_type_id_connection_requires** — Get entities that the given entity requires. (GET /api/v2/dependencies/type/{entityType}/id/{entityId}/connections/requires) Requires permission dependencies:dependency:view. Required: entity_type, entity_id.
- **genesys_cloud_diagnostic_logcapture_browser_entries_search** — Query collected log entries. It returns a limited amount of records, to get all records use download endpoint. (POST /api/v2/diagnostics/logcapture/browser/entries/query) Requires permission troubleshooting:logCapture:view. Required: interval, userId.
- **create_diagnostic_logcapture_browser_entry_download_job** — Creates an async download execution. (POST /api/v2/diagnostics/logcapture/browser/entries/download/jobs) Requires permission troubleshooting:logCapture:add. Required: interval, userId.
- **get_diagnostic_logcapture_browser_entry_download_job_by_id** — Gets status of async download execution. (GET /api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}) Requires permission troubleshooting:logCapture:view. The id is the jobId. Required: id.
- **create_a_genesys_cloud_diagnostic_logcapture_browser_user** — Enable log capture for a user or update expiration. (POST /api/v2/diagnostics/logcapture/browser/users/{userId}) Requires permission troubleshooting:logCapture:add. Required: user_id, dateExpired.
- **delete_a_genesys_cloud_diagnostic_logcapture_browser_user_by_id** — Disable browser log capture for the user. (DELETE /api/v2/diagnostics/logcapture/browser/users/{userId}) Requires permission troubleshooting:logCapture:delete. The id is the userId. Required: id.
- **get_diagnostic_logcapture_browser_user_by_id** — Get log capture configuration for the user. (GET /api/v2/diagnostics/logcapture/browser/users/{userId}) Requires permission troubleshooting:logCapture:view. The id is the userId. Required: id.
- **list_all_genesys_cloud_diagnostic_logcapture_browser_users** — Get all log capture enabled users for an org. (GET /api/v2/diagnostics/logcapture/browser/users) Requires permission troubleshooting:logCapture:view.
- **get_single_genesys_cloud_download_by_id** — Issues a redirect to a signed secure download URL for specified download. this method will issue a redirect to the url to the content. (GET /api/v2/downloads/{downloadId}) The id is the downloadId. Required: id.
- **genesys_cloud_email_settings_bulk_partial_update** — Patch email Contact Center settings. (PATCH /api/v2/emails/settings) Requires permission conversation:settings:edit.
- **genesys_cloud_email_settings_lookup** — Get email Contact Center settings. (GET /api/v2/emails/settings) Requires permission conversation:settings:view.
- **genesys_cloud_email_settings_threading_bulk_delete** — Reset email threading settings to default. (DELETE /api/v2/emails/settings/threading) Requires permission conversation:emailThreadingSettings:edit.
- **genesys_cloud_email_settings_threading_bulk_partial_update** — Patch email threading settings. (PATCH /api/v2/emails/settings/threading) Requires permission conversation:emailThreadingSettings:edit.
- **genesys_cloud_email_settings_threading_lookup** — Get email threading settings. (GET /api/v2/emails/settings/threading) Requires permission conversation:emailThreadingSettings:view.
- **delete_a_genesys_cloud_employeeengagement_celebration_by_id** — Deletes a celebration. (DELETE /api/v2/employeeengagement/celebrations/{celebrationId}) Requires permission engagement:celebration:delete. The id is the celebrationId. Required: id.
- **list_all_genesys_cloud_employeeengagement_celebrations** — Get all celebrations. (GET /api/v2/employeeengagement/celebrations) Requires permission engagement:celebration:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_employeeengagement_celebration_by_id** — Set a state for a celebration. (PATCH /api/v2/employeeengagement/celebrations/{celebrationId}) Requires permission engagement:celebration:edit. The id is the celebrationId. Required: id.
- **create_a_genesys_cloud_employeeengagement_recognition** — Creates a recognition. (POST /api/v2/employeeengagement/recognitions) Requires permission engagement:recognition:add. Required: recipientId, type, title.
- **get_single_genesys_cloud_employeeengagement_recognition_by_id** — Gets a single recognition. (GET /api/v2/employeeengagement/recognitions/{recognitionId}) Requires permission engagement:recognition:view. The id is the recognitionId. Required: id.
- **list_all_genesys_cloud_employeeengagement_recognitions** — Gets sent recognitions. (GET /api/v2/employeeengagement/recognitions) Requires permission engagement:recognition:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_employeeperformance_externalmetrics_datum** — Write External Metric Data. (POST /api/v2/employeeperformance/externalmetrics/data) Requires permission employeePerformance:externalMetricData:add. Required: items.
- **create_employeeperformance_externalmetrics_definition** — Create External Metric Definition. (POST /api/v2/employeeperformance/externalmetrics/definitions) Requires permission employeePerformance:externalMetricDefinition:add. Required: name, unit, precision, defaultObjectiveType, enabled.
- **delete_employeeperformance_externalmetrics_definition_by_id** — Delete an External Metric Definition. (DELETE /api/v2/employeeperformance/externalmetrics/definitions/{metricId}) Requires permission employeePerformance:externalMetricDefinition:delete. The id is the metricId. Required: id.
- **get_employeeperformance_externalmetrics_definition_by_id** — Get an External Metric Definition. (GET /api/v2/employeeperformance/externalmetrics/definitions/{metricId}) Requires permission employeePerformance:externalMetricDefinition:view. The id is the metricId. Required: id.
- **list_all_employeeperformance_externalmetrics_definitions** — Get a list of External Metric Definitions of an organization, sorted by name in ascending order. (GET /api/v2/employeeperformance/externalmetrics/definitions) Requires permission employeePerformance:externalMetricDefinition:view. Pages automatically with pageNumber/pageSize.
- **update_employeeperformance_externalmetrics_definition_by_id** — Update External Metric Definition. (PATCH /api/v2/employeeperformance/externalmetrics/definitions/{metricId}) Requires permission employeePerformance:externalMetricDefinition:edit. The id is the metricId. Required: id.
- **create_a_genesys_cloud_event_conversation** — Publish Conversation Batch Events. (POST /api/v2/events/conversations) Requires permission conversation:conversation:inject.
- **create_a_genesys_cloud_event_routing_customkpiattribution** — Publish Predictive Routing Custom Kpi Attribution Batch Events. (POST /api/v2/events/routing/customkpiattributions) Requires permission routing:customKpiAttribution:inject.
- **create_a_genesys_cloud_event_user_presence** — Publish User Presence Status Batch Events. (POST /api/v2/events/users/presence) Requires permission presence:userPresence:inject.
- **create_a_genesys_cloud_event_user_routingstatus** — Publish Agent Routing Status Batch Events. (POST /api/v2/events/users/routingstatus) Requires permission routing:routingstatus:inject.
- **create_a_genesys_cloud_externalcontact_bulk_contact_add** — Bulk add contacts. (POST /api/v2/externalcontacts/bulk/contacts/add) Requires permission externalContacts:contact:add.
- **create_a_genesys_cloud_externalcontact_bulk_contact_divisionview** — Bulk fetch contacts across divisions. (POST /api/v2/externalcontacts/bulk/contacts/divisionviews) Requires permission externalContacts:contact:search.
- **create_a_genesys_cloud_externalcontact_bulk_contact_enrich** — Bulk Enrich Contacts - Run up to 10 Enrich operations per request. See the API endpoint /externalcontacts/contacts/enrich for docs on individual Enrich operations. (POST /api/v2/externalcontacts/bulk/contacts/enrich) Requires permission externalContacts:contact:enrich.
- **create_a_genesys_cloud_externalcontact_bulk_contact_remove** — Bulk remove contacts. (POST /api/v2/externalcontacts/bulk/contacts/remove) Requires permission externalContacts:contact:delete.
- **create_a_genesys_cloud_externalcontact_bulk_contact_unresolved** — Bulk fetch unresolved ancestor contacts. (POST /api/v2/externalcontacts/bulk/contacts/unresolved) Requires permission externalContacts:contact:view.
- **create_a_genesys_cloud_externalcontact_bulk_contact_update** — Bulk update contacts. (POST /api/v2/externalcontacts/bulk/contacts/update) Requires permission externalContacts:contact:edit.
- **create_a_genesys_cloud_externalcontact_bulk_contact** — Bulk fetch contacts. (POST /api/v2/externalcontacts/bulk/contacts) Requires permission externalContacts:contact:view.
- **create_a_genesys_cloud_externalcontact_bulk_note_add** — Bulk add notes. (POST /api/v2/externalcontacts/bulk/notes/add) Requires permissions externalContacts:contact:add, externalContacts:externalOrganization:add.
- **create_a_genesys_cloud_externalcontact_bulk_note_remove** — Bulk remove notes. (POST /api/v2/externalcontacts/bulk/notes/remove) Requires permissions externalContacts:contact:delete, externalContacts:externalOrganization:delete.
- **create_a_genesys_cloud_externalcontact_bulk_note_update** — Bulk update notes. (POST /api/v2/externalcontacts/bulk/notes/update) Requires permissions externalContacts:contact:edit, externalContacts:externalOrganization:edit.
- **create_a_genesys_cloud_externalcontact_bulk_note** — Bulk fetch notes. (POST /api/v2/externalcontacts/bulk/notes) Requires permissions externalContacts:contact:view, externalContacts:externalOrganization:view.
- **create_a_genesys_cloud_externalcontact_bulk_organization_add** — Bulk add organizations. (POST /api/v2/externalcontacts/bulk/organizations/add) Requires permission externalContacts:externalOrganization:add.
- **create_externalcontact_bulk_organization_divisionview** — Bulk fetch organizations across divisions. (POST /api/v2/externalcontacts/bulk/organizations/divisionviews) Requires permission externalContacts:externalOrganization:search.
- **create_a_genesys_cloud_externalcontact_bulk_organization_enrich** — Bulk enrich external organizations - Run up to 10 Enrich operations per request. See the API endpoint /externalcontacts/organizations/enrich for docs on individual Enrich operations. (POST /api/v2/externalcontacts/bulk/organizations/enrich) Requires permission externalContacts:externalOrganization:enrich.
- **create_a_genesys_cloud_externalcontact_bulk_organization_remove** — Bulk remove organizations. (POST /api/v2/externalcontacts/bulk/organizations/remove) Requires permission externalContacts:externalOrganization:delete.
- **create_a_genesys_cloud_externalcontact_bulk_organization_update** — Bulk update organizations. (POST /api/v2/externalcontacts/bulk/organizations/update) Requires permission externalContacts:externalOrganization:edit.
- **create_a_genesys_cloud_externalcontact_bulk_organization** — Bulk fetch organizations. (POST /api/v2/externalcontacts/bulk/organizations) Requires permission externalContacts:externalOrganization:view.
- **create_a_genesys_cloud_externalcontact_bulk_relationship_add** — Bulk add relationships. (POST /api/v2/externalcontacts/bulk/relationships/add) Requires permissions externalContacts:contact:add, externalContacts:externalOrganization:add.
- **create_a_genesys_cloud_externalcontact_bulk_relationship_remove** — Bulk remove relationships. (POST /api/v2/externalcontacts/bulk/relationships/remove) Requires permissions externalContacts:contact:delete, externalContacts:externalOrganization:delete.
- **create_a_genesys_cloud_externalcontact_bulk_relationship_update** — Bulk update relationships. (POST /api/v2/externalcontacts/bulk/relationships/update) Requires permissions externalContacts:contact:edit, externalContacts:externalOrganization:edit.
- **create_a_genesys_cloud_externalcontact_bulk_relationship** — Bulk fetch relationships. (POST /api/v2/externalcontacts/bulk/relationships) Requires permissions externalContacts:contact:view, externalContacts:externalOrganization:view.
- **create_a_genesys_cloud_externalcontact_contact_enrich** — Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/contacts. A 201 response status indicates that a new Contact was created, whereas a 200 status indicates that a Contact was updated or a merge occurred. (POST /api/v2/externalcontacts/contacts/enrich) Requires permission externalContacts:contact:enrich. Required: matchingIdentifiers, action.
- **create_a_genesys_cloud_externalcontact_contact_export** — Create bulk export. (POST /api/v2/externalcontacts/contacts/exports) Requires permissions externalContacts:export:add, externalContacts:contact:view.
- **get_single_genesys_cloud_externalcontact_contact_export_by_id** — Get export for exportId. (GET /api/v2/externalcontacts/contacts/exports/{exportId}) Requires permissions externalContacts:export:view, externalContacts:contact:view. The id is the exportId. Required: id.
- **list_all_genesys_cloud_externalcontact_contact_exports** — List contact exports for organization. (GET /api/v2/externalcontacts/contacts/exports) Requires permissions externalContacts:export:view, externalContacts:contact:view. Pages automatically: pass the returned next_cursor to get the next page.
- **externalcontact_contact_identifiers_bulk_partial_update** — Claim or release identifiers for a contact. (PATCH /api/v2/externalcontacts/contacts/{contactId}/identifiers) Requires permission externalContacts:contact:edit. Required: contact_id, operation, identifier.
- **list_all_genesys_cloud_externalcontact_contact_identifiers** — List the identifiers for a contact. (GET /api/v2/externalcontacts/contacts/{contactId}/identifiers) Requires permission externalContacts:contact:view. Required: contact_id.
- **create_a_genesys_cloud_externalcontact_contact_journey_segment** — Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. (POST /api/v2/externalcontacts/contacts/{contactId}/journey/segments) Requires any of permissions externalContacts:segmentAssignment:add, externalContacts:segmentAssignment:delete. Required: contact_id.
- **list_all_genesys_cloud_externalcontact_contact_journey_segments** — Retrieve segment assignments by external contact ID. (GET /api/v2/externalcontacts/contacts/{contactId}/journey/segments) Requires permission externalContacts:segmentAssignment:view. Required: contact_id.
- **list_all_genesys_cloud_externalcontact_contact_journey_sessions** — Retrieve all sessions for a given external contact. (GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions) Requires permission externalContacts:session:view. Pages automatically: pass the returned next_cursor to get the next page. Required: contact_id.
- **create_a_genesys_cloud_externalcontact_contact_note** — Create a note for an external contact. (POST /api/v2/externalcontacts/contacts/{contactId}/notes) Requires any of permissions relate:contact:edit, externalContacts:contact:edit. Required: contact_id, createdBy.
- **delete_a_genesys_cloud_externalcontact_contact_note_by_id** — Delete a note for an external contact. (DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}) Requires any of permissions relate:contact:edit, externalContacts:contact:edit. The id is the noteId. Required: id, contact_id.
- **get_single_genesys_cloud_externalcontact_contact_note_by_id** — Fetch a note for an external contact. (GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}) Requires any of permissions relate:contact:view, externalContacts:contact:view. The id is the noteId. Required: id, contact_id.
- **list_all_genesys_cloud_externalcontact_contact_notes** — List notes for an external contact. (GET /api/v2/externalcontacts/contacts/{contactId}/notes) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically with pageNumber/pageSize. Required: contact_id.
- **genesys_cloud_externalcontact_contact_notes_partial_update** — Update a Contact Note. (PATCH /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}) Requires permission externalContacts:contact:edit. Required: contact_id, note_id.
- **update_a_genesys_cloud_externalcontact_contact_note_by_id** — Update a note for an external contact. (PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}) Requires any of permissions relate:contact:edit, externalContacts:contact:edit. The id is the noteId. Required: id, contact_id, createdBy.
- **create_a_genesys_cloud_externalcontact_contact_promotion** — Promote an observed contact (ephemeral or identified) to a curated contact. (POST /api/v2/externalcontacts/contacts/{contactId}/promotion) Requires permission externalContacts:identity:promote. Required: contact_id.
- **get_externalcontact_contact_schema_coretype_by_id** — Get a specific named core type. (GET /api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}) Requires permission externalContacts:customFields:view. The id is the coreTypeName. Required: id.
- **list_all_genesys_cloud_externalcontact_contact_schema_coretypes** — Get the core types from which all schemas are built. (GET /api/v2/externalcontacts/contacts/schemas/coretypes) Requires permission externalContacts:customFields:view.
- **genesys_cloud_externalcontact_contact_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/externalcontacts/contacts/schemas/limits) Requires permission externalContacts:customFields:view.
- **get_externalcontact_contact_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}) Requires permission externalContacts:customFields:view. The id is the versionId. Required: id, schema_id.
- **list_all_genesys_cloud_externalcontact_contact_schema_versions** — Get all versions of an external contact's schema. (GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions) Requires permission externalContacts:customFields:view. Required: schema_id.
- **create_a_genesys_cloud_externalcontact_contact_schema** — Create a schema. (POST /api/v2/externalcontacts/contacts/schemas) Requires permission externalContacts:customFields:add. Required: version, jsonSchema.
- **delete_a_genesys_cloud_externalcontact_contact_schema_by_id** — Delete a schema. (DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId}) Requires permission externalContacts:customFields:edit. The id is the schemaId. Required: id.
- **get_single_genesys_cloud_externalcontact_contact_schema_by_id** — Get a schema. (GET /api/v2/externalcontacts/contacts/schemas/{schemaId}) Requires permission externalContacts:customFields:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_externalcontact_contact_schemas** — Get a list of schemas. (GET /api/v2/externalcontacts/contacts/schemas) Requires permission externalContacts:customFields:view.
- **update_a_genesys_cloud_externalcontact_contact_schema_by_id** — Update a schema. (PUT /api/v2/externalcontacts/contacts/schemas/{schemaId}) Requires permission externalContacts:customFields:edit. The id is the schemaId. Required: id, version, jsonSchema.
- **genesys_cloud_externalcontact_contact_unresolved_lookup** — Fetch an unresolved external contact. (GET /api/v2/externalcontacts/contacts/{contactId}/unresolved) Requires permission externalContacts:contact:view. Required: contact_id.
- **create_a_genesys_cloud_externalcontact_contact** — Create an external contact. (POST /api/v2/externalcontacts/contacts) Requires any of permissions relate:contact:add, externalContacts:contact:add.
- **delete_a_genesys_cloud_externalcontact_contact_by_id** — Delete an external contact. (DELETE /api/v2/externalcontacts/contacts/{contactId}) Requires any of permissions relate:contact:delete, externalContacts:contact:delete. The id is the contactId. Required: id.
- **get_single_genesys_cloud_externalcontact_contact_by_id** — Fetch an external contact. (GET /api/v2/externalcontacts/contacts/{contactId}) Requires any of permissions relate:contact:view, externalContacts:contact:view. The id is the contactId. Required: id.
- **list_all_genesys_cloud_externalcontact_contacts** — Search for external contacts. (GET /api/v2/externalcontacts/contacts) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_externalcontact_contacts_merge** — Merge up to 25 contacts into a new contact record. Merge operation may fail if the resulting mergeset exceeds our default limit of 52. The valueOverride field lets you override any of the Contact fields post-merge. If any Contact field is left null in valueOverride, it will be taken from the most recently-modified contact in the merge set. (POST /api/v2/externalcontacts/contacts/merge) Requires permission externalContacts:identity:merge. Required: contactIds.
- **genesys_cloud_externalcontact_contacts_partial_update** — Update specific fields of an external contact. (PATCH /api/v2/externalcontacts/contacts/{contactId}) Requires permission externalContacts:contact:edit. Required: contact_id.
- **genesys_cloud_externalcontact_contacts_search** — Search for external contacts. (POST /api/v2/externalcontacts/contacts/search) Requires permission externalContacts:contact:view.
- **update_a_genesys_cloud_externalcontact_contact_by_id** — Update an external contact. (PUT /api/v2/externalcontacts/contacts/{contactId}) Requires any of permissions relate:contact:edit, externalContacts:contact:edit. The id is the contactId. Required: id.
- **update_a_genesys_cloud_externalcontact_conversation_by_id** — Associate/disassociate an external contact with a conversation. To associate, supply a value for the externalContactId. To disassociate, do not include the property at all. (PUT /api/v2/externalcontacts/conversations/{conversationId}) Requires any of permissions relate:conversation:associate, externalContacts:conversation:associate. The id is the conversationId. Required: id, conversationId, communicationId, mediaType.
- **create_a_genesys_cloud_externalcontact_externalsource** — Create an External Source. (POST /api/v2/externalcontacts/externalsources) Requires permission externalContacts:externalSource:add. Required: name.
- **delete_a_genesys_cloud_externalcontact_externalsource_by_id** — Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. (DELETE /api/v2/externalcontacts/externalsources/{externalSourceId}) Requires permission externalContacts:externalSource:delete. The id is the externalSourceId. Required: id.
- **get_single_genesys_cloud_externalcontact_externalsource_by_id** — Fetch an External Source. (GET /api/v2/externalcontacts/externalsources/{externalSourceId}) Requires any of permissions externalContacts:externalSource:view, externalContacts:contact:view, externalContacts:externalOrganization:view. The id is the externalSourceId. Required: id.
- **list_all_genesys_cloud_externalcontact_externalsources** — Fetch a list of External Sources. (GET /api/v2/externalcontacts/externalsources) Requires any of permissions externalContacts:externalSource:view, externalContacts:contact:view, externalContacts:externalOrganization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_externalcontact_externalsource_by_id** — Update an External Source. (PUT /api/v2/externalcontacts/externalsources/{externalSourceId}) Requires permission externalContacts:externalSource:edit. The id is the externalSourceId. Required: id, name.
- **externalcontact_graph_clusterscan_cluster_merge_bulk_update** — Merge a single cluster found by a scan. (PUT /api/v2/externalcontacts/graphs/clusterscans/{scanId}/clusters/{clusterId}/merge) Requires permission externalContacts:graphCluster:merge. Required: scan_id, cluster_id.
- **get_externalcontact_graph_clusterscan_cluster_by_id** — Returns a single cluster found by a scan. (GET /api/v2/externalcontacts/graphs/clusterscans/{scanId}/clusters/{clusterId}) Requires permission externalContacts:graphCluster:view. The id is the clusterId. Required: id, scan_id.
- **list_all_externalcontact_graph_clusterscan_clusters** — Returns a list of clusters found by a scan. (GET /api/v2/externalcontacts/graphs/clusterscans/{scanId}/clusters) Requires permission externalContacts:graphCluster:view. Pages automatically: pass the returned next_cursor to get the next page. Required: scan_id.
- **genesys_cloud_externalcontact_graph_clusterscan_latest_lookup** — Returns the latest cluster scan. (GET /api/v2/externalcontacts/graphs/clusterscans/latest) Requires permission externalContacts:contact:view.
- **externalcontact_graph_clusterscan_latest_statistics_lookup** — Returns the statistics about the latest cluster scan. (GET /api/v2/externalcontacts/graphs/clusterscans/latest/statistics) Requires permission externalContacts:contact:view.
- **externalcontact_graph_clusterscan_statistics_lookup** — Returns the statistics about a single cluster scan. (GET /api/v2/externalcontacts/graphs/clusterscans/{scanId}/statistics) Requires permission externalContacts:graphClusterScan:view. Required: scan_id.
- **get_single_genesys_cloud_externalcontact_graph_clusterscan_by_id** — Returns a single cluster scan. (GET /api/v2/externalcontacts/graphs/clusterscans/{scanId}) Requires permission externalContacts:graphClusterScan:view. The id is the scanId. Required: id.
- **list_all_genesys_cloud_externalcontact_graph_clusterscans** — Returns a list of cluster scans. (GET /api/v2/externalcontacts/graphs/clusterscans) Requires permission externalContacts:graphClusterScan:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_externalcontact_graph_settings_bulk_update** — Updates the org-wide settings for ExternalContact graph operations. (PUT /api/v2/externalcontacts/graphs/settings) Requires permission externalContacts:graphSettingsGlobal:edit.
- **genesys_cloud_externalcontact_graph_settings_lookup** — Returns the org-wide settings for ExternalContact graph operations. (GET /api/v2/externalcontacts/graphs/settings) Requires permission externalContacts:graphSettingsGlobal:view.
- **create_a_genesys_cloud_externalcontact_identifierlookup_contact** — Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: "+1 704 298 4733". (POST /api/v2/externalcontacts/identifierlookup/contacts) Requires permission externalContacts:contact:view. Required: type, value.
- **create_externalcontact_identifierlookup_organization** — Fetch an external organization using an identifier type and value. This endpoint will only accept ExternalId type identifiers. (POST /api/v2/externalcontacts/identifierlookup/organizations) Requires permission externalContacts:externalOrganization:view. Required: type, value.
- **create_a_genesys_cloud_externalcontact_import_csv_job** — Create CSV import job. (POST /api/v2/externalcontacts/import/csv/jobs) Requires permission externalContacts:importCsvJob:add. Required: uploadId, settingsId.
- **create_a_genesys_cloud_externalcontact_import_csv_setting** — Create settings for CSV import. (POST /api/v2/externalcontacts/import/csv/settings) Requires permission externalContacts:importCsvSettings:add. Required: mappings.
- **delete_a_genesys_cloud_externalcontact_import_csv_setting_by_id** — Delete settings for CSV import. (DELETE /api/v2/externalcontacts/import/csv/settings/{settingsId}) Requires permission externalContacts:importCsvSettings:delete. The id is the settingsId. Required: id.
- **get_externalcontact_import_csv_setting_by_id** — Get settings for CSV import. (GET /api/v2/externalcontacts/import/csv/settings/{settingsId}) Requires permission externalContacts:importCsvSettings:view. The id is the settingsId. Required: id.
- **list_all_genesys_cloud_externalcontact_import_csv_settings** — Retrieve all settings for organization filtered by externalSettingsId if provided. (GET /api/v2/externalcontacts/import/csv/settings) Requires permission externalContacts:importCsvSettings:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_externalcontact_import_csv_setting_by_id** — Update settings for CSV import. (PUT /api/v2/externalcontacts/import/csv/settings/{settingsId}) Requires permission externalContacts:importCsvSettings:edit. The id is the settingsId. Required: id, mappings.
- **genesys_cloud_externalcontact_import_csv_upload_details_lookup** — Get details for CSV upload. (GET /api/v2/externalcontacts/import/csv/uploads/{uploadId}/details) Requires permission externalContacts:importCsvUpload:view. Required: upload_id.
- **genesys_cloud_externalcontact_import_csv_upload_preview_lookup** — Get preview for CSV upload. (GET /api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview) Requires permission externalContacts:importCsvUpload:view. Required: upload_id.
- **create_a_genesys_cloud_externalcontact_import_csv_upload** — Get url for CSV upload. (POST /api/v2/externalcontacts/import/csv/uploads) Requires permission externalContacts:importCsvUpload:add. Required: fileSize.
- **create_a_genesys_cloud_externalcontact_import_job** — Create a new job. (POST /api/v2/externalcontacts/import/jobs) Requires permission externalContacts:importJob:add. Required: settingsId.
- **get_single_genesys_cloud_externalcontact_import_job_by_id** — Get job based on id. (GET /api/v2/externalcontacts/import/jobs/{jobId}) Requires permission externalContacts:importJob:view. The id is the jobId. Required: id.
- **list_all_genesys_cloud_externalcontact_import_jobs** — List jobs for organization. (GET /api/v2/externalcontacts/import/jobs) Requires permission externalContacts:importJob:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_externalcontact_import_job_by_id** — Update Job's workflow status. (PUT /api/v2/externalcontacts/import/jobs/{jobId}) Requires permission externalContacts:importJob:edit. The id is the jobId. Required: id, jobId, status.
- **create_a_genesys_cloud_externalcontact_import_setting** — Create a new settings. (POST /api/v2/externalcontacts/import/settings) Requires permission externalContacts:importSettings:add. Required: name, mergeContacts, externalSourceId, importFields.
- **delete_a_genesys_cloud_externalcontact_import_setting_by_id** — Delete Settings. (DELETE /api/v2/externalcontacts/import/settings/{settingsId}) Requires permission externalContacts:importSettings:delete. The id is the settingsId. Required: id.
- **get_single_genesys_cloud_externalcontact_import_setting_by_id** — Get setting based on id. (GET /api/v2/externalcontacts/import/settings/{settingsId}) Requires permission externalContacts:importSettings:view. The id is the settingsId. Required: id.
- **list_all_genesys_cloud_externalcontact_import_settings** — List settings for organization. (GET /api/v2/externalcontacts/import/settings) Requires permission externalContacts:importSettings:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_externalcontact_import_setting_by_id** — Update settings. (PUT /api/v2/externalcontacts/import/settings/{settingsId}) Requires permission externalContacts:importSettings:edit. The id is the settingsId. Required: id, name, mergeContacts, externalSourceId, importFields.
- **create_a_genesys_cloud_externalcontact_note_export** — Create notes export. (POST /api/v2/externalcontacts/notes/exports) Requires permissions externalContacts:export:add, externalContacts:contact:view, externalContacts:externalOrganization:view.
- **get_single_genesys_cloud_externalcontact_note_export_by_id** — Get notes export for exportId. (GET /api/v2/externalcontacts/notes/exports/{exportId}) Requires permissions externalContacts:export:view, externalContacts:contact:view, externalContacts:externalOrganization:view. The id is the exportId. Required: id.
- **list_all_genesys_cloud_externalcontact_note_exports** — List note exports for organization. (GET /api/v2/externalcontacts/notes/exports) Requires permissions externalContacts:export:view, externalContacts:contact:view, externalContacts:externalOrganization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_externalcontact_organization_contacts** — Search for external contacts in an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically with pageNumber/pageSize. Required: external_organization_id.
- **create_a_genesys_cloud_externalcontact_organization_enrich** — Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. You may also submit multiple Enrich operations in one request via the Bulk Enrich API at /externalcontacts/bulk/organizations. A 201 response status indicates that a new External Organization was created, whereas a 200 status indicates that an External Organization was updated. (POST /api/v2/externalcontacts/organizations/enrich) Requires permission externalContacts:externalOrganization:enrich.
- **create_a_genesys_cloud_externalcontact_organization_export** — Create organizations export. (POST /api/v2/externalcontacts/organizations/exports) Requires permissions externalContacts:export:add, externalContacts:externalOrganization:view.
- **get_externalcontact_organization_export_by_id** — Get organizations export for exportId. (GET /api/v2/externalcontacts/organizations/exports/{exportId}) Requires permissions externalContacts:export:view, externalContacts:externalOrganization:view. The id is the exportId. Required: id.
- **list_all_genesys_cloud_externalcontact_organization_exports** — List organization exports for organization. (GET /api/v2/externalcontacts/organizations/exports) Requires permissions externalContacts:export:view, externalContacts:externalOrganization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **externalcontact_organization_identifiers_bulk_partial_update** — Claim or release identifiers for an external organization. (PATCH /api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers) Requires permission externalContacts:externalOrganization:edit. Required: external_organization_id, operation, identifier.
- **list_all_genesys_cloud_externalcontact_organization_identifiers** — List the identifiers for an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers) Requires permission externalContacts:externalOrganization:view. Required: external_organization_id.
- **create_a_genesys_cloud_externalcontact_organization_note** — Create a note for an external organization. (POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. Required: external_organization_id, createdBy.
- **delete_a_genesys_cloud_externalcontact_organization_note_by_id** — Delete a note for an external organization. (DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. The id is the noteId. Required: id, external_organization_id.
- **get_single_genesys_cloud_externalcontact_organization_note_by_id** — Fetch a note for an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. The id is the noteId. Required: id, external_organization_id.
- **list_all_genesys_cloud_externalcontact_organization_notes** — List notes for an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. Pages automatically with pageNumber/pageSize. Required: external_organization_id.
- **genesys_cloud_externalcontact_organization_notes_partial_update** — Update an External Organization Note. (PATCH /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}) Requires permission externalContacts:externalOrganization:edit. Required: external_organization_id, note_id.
- **update_a_genesys_cloud_externalcontact_organization_note_by_id** — Update a note for an external organization. (PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. The id is the noteId. Required: id, external_organization_id, createdBy.
- **list_all_externalcontact_organization_relationships** — Fetch a relationship for an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. Pages automatically with pageNumber/pageSize. Required: external_organization_id.
- **get_externalcontact_organization_schema_coretype_by_id** — Get a specific named core type. (GET /api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}) Requires permission externalContacts:customFields:view. The id is the coreTypeName. Required: id.
- **list_all_externalcontact_organization_schema_coretypes** — Get the core types from which all schemas are built. (GET /api/v2/externalcontacts/organizations/schemas/coretypes) Requires permission externalContacts:customFields:view.
- **genesys_cloud_externalcontact_organization_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/externalcontacts/organizations/schemas/limits) Requires permission externalContacts:customFields:view.
- **get_externalcontact_organization_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}) Requires permission externalContacts:customFields:view. The id is the versionId. Required: id, schema_id.
- **list_all_externalcontact_organization_schema_versions** — Get all versions of an external organization's schema. (GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions) Requires permission externalContacts:customFields:view. Required: schema_id.
- **create_a_genesys_cloud_externalcontact_organization_schema** — Create a schema. (POST /api/v2/externalcontacts/organizations/schemas) Requires permission externalContacts:customFields:add. Required: version, jsonSchema.
- **get_externalcontact_organization_schema_by_id** — Get a schema. (GET /api/v2/externalcontacts/organizations/schemas/{schemaId}) Requires permission externalContacts:customFields:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_externalcontact_organization_schemas** — Get a list of schemas. (GET /api/v2/externalcontacts/organizations/schemas) Requires permission externalContacts:customFields:view.
- **update_a_genesys_cloud_externalcontact_organization_schema_by_id** — Update a schema. (PUT /api/v2/externalcontacts/organizations/schemas/{schemaId}) Requires permission externalContacts:customFields:edit. The id is the schemaId. Required: id, version, jsonSchema.
- **genesys_cloud_externalcontact_organization_trustor_bulk_delete** — Unlink the Trustor for this External Organization. (DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor) Requires permission externalContacts:externalOrganization:edit. Required: external_organization_id.
- **update_externalcontact_organization_trustor_by_id** — Links a Trustor with an External Organization. (PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}) Requires permission externalContacts:externalOrganization:edit. The id is the trustorId. Required: id, external_organization_id.
- **create_a_genesys_cloud_externalcontact_organization** — Create an external organization. (POST /api/v2/externalcontacts/organizations) Requires any of permissions relate:externalOrganization:add, externalContacts:externalOrganization:add. Required: name.
- **delete_a_genesys_cloud_externalcontact_organization_by_id** — Delete an external organization. (DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}) Requires any of permissions relate:externalOrganization:delete, externalContacts:externalOrganization:delete. The id is the externalOrganizationId. Required: id.
- **get_single_genesys_cloud_externalcontact_organization_by_id** — Fetch an external organization. (GET /api/v2/externalcontacts/organizations/{externalOrganizationId}) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. The id is the externalOrganizationId. Required: id.
- **list_all_genesys_cloud_externalcontact_organizations** — Search for external organizations. (GET /api/v2/externalcontacts/organizations) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_externalcontact_organizations_partial_update** — Update specific fields of an external organization. (PATCH /api/v2/externalcontacts/organizations/{externalOrganizationId}) Requires permission externalContacts:externalOrganization:edit. Required: external_organization_id.
- **update_a_genesys_cloud_externalcontact_organization_by_id** — Update an external organization. (PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. The id is the externalOrganizationId. Required: id, name.
- **create_a_genesys_cloud_externalcontact_relationship_export** — Create relationships export. (POST /api/v2/externalcontacts/relationships/exports) Requires permissions externalContacts:export:add, externalContacts:externalOrganization:view.
- **get_externalcontact_relationship_export_by_id** — Get relationships export for exportId. (GET /api/v2/externalcontacts/relationships/exports/{exportId}) Requires permissions externalContacts:export:view, externalContacts:externalOrganization:view. The id is the exportId. Required: id.
- **list_all_genesys_cloud_externalcontact_relationship_exports** — List relationship exports for organization. (GET /api/v2/externalcontacts/relationships/exports) Requires permissions externalContacts:export:view, externalContacts:externalOrganization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **create_a_genesys_cloud_externalcontact_relationship** — Create a relationship. (POST /api/v2/externalcontacts/relationships) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. Required: user, externalOrganization, relationship.
- **delete_a_genesys_cloud_externalcontact_relationship_by_id** — Delete a relationship. (DELETE /api/v2/externalcontacts/relationships/{relationshipId}) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. The id is the relationshipId. Required: id.
- **get_single_genesys_cloud_externalcontact_relationship_by_id** — Fetch a relationship. (GET /api/v2/externalcontacts/relationships/{relationshipId}) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. The id is the relationshipId. Required: id.
- **genesys_cloud_externalcontact_relationships_partial_update** — Update specific fields of a relationship. (PATCH /api/v2/externalcontacts/relationships/{relationshipId}) Requires permission externalContacts:externalOrganization:edit. Required: relationship_id.
- **update_a_genesys_cloud_externalcontact_relationship_by_id** — Update a relationship. (PUT /api/v2/externalcontacts/relationships/{relationshipId}) Requires any of permissions relate:externalOrganization:edit, externalContacts:externalOrganization:edit. The id is the relationshipId. Required: id, user, externalOrganization, relationship.
- **list_all_genesys_cloud_externalcontact_reversewhitepageslookup** — Look up contacts based on an attribute. Maximum of 25 values returned. (GET /api/v2/externalcontacts/reversewhitepageslookup) Requires permission externalContacts:contact:view. Required: lookupVal.
- **list_all_externalcontact_scan_contact_divisionview_all** — Scan for external contacts using paging. (GET /api/v2/externalcontacts/scan/contacts/divisionviews/all) Requires permission externalContacts:contact:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_externalcontact_scan_contacts** — Scan for external contacts using paging. (GET /api/v2/externalcontacts/scan/contacts) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_externalcontact_scan_note_divisionview_all** — Scan for notes using paging. (GET /api/v2/externalcontacts/scan/notes/divisionviews/all) Requires permission externalContacts:contact:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_externalcontact_scan_notes** — Scan for notes using paging. (GET /api/v2/externalcontacts/scan/notes) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_externalcontact_scan_organization_divisionview_all** — Scan for external organizations using paging. (GET /api/v2/externalcontacts/scan/organizations/divisionviews/all) Requires permission externalContacts:externalOrganization:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_externalcontact_scan_organizations** — Scan for external organizations using paging. (GET /api/v2/externalcontacts/scan/organizations) Requires any of permissions relate:externalOrganization:view, externalContacts:externalOrganization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_externalcontact_scan_relationship_divisionview_all** — Scan for relationships. (GET /api/v2/externalcontacts/scan/relationships/divisionviews/all) Requires permission externalContacts:contact:viewAll. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_externalcontact_scan_relationships** — Scan for relationships. (GET /api/v2/externalcontacts/scan/relationships) Requires any of permissions relate:contact:view, externalContacts:contact:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_externalcontact_settings_bulk_delete** — Delete settings. (DELETE /api/v2/externalcontacts/settings) Requires permission externalContacts:settings:delete.
- **genesys_cloud_externalcontact_settings_bulk_update** — Set settings. (PUT /api/v2/externalcontacts/settings) Requires permission externalContacts:settings:edit.
- **genesys_cloud_externalcontact_settings_lookup** — Get settings. (GET /api/v2/externalcontacts/settings) Requires permission externalContacts:settings:view.
- **genesys_cloud_fax_document_content_lookup** — Download a fax document. (GET /api/v2/fax/documents/{documentId}/content) Required: document_id.
- **delete_a_genesys_cloud_fax_document_by_id** — Delete a fax document. (DELETE /api/v2/fax/documents/{documentId}) The id is the documentId. Required: id.
- **get_single_genesys_cloud_fax_document_by_id** — Get a document. (GET /api/v2/fax/documents/{documentId}) The id is the documentId. Required: id.
- **list_all_genesys_cloud_fax_documents** — Get a list of fax documents. (GET /api/v2/fax/documents) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_fax_document_by_id** — Update a fax document. (PUT /api/v2/fax/documents/{documentId}) The id is the documentId. Required: id.
- **genesys_cloud_fax_settings_bulk_update** — Update/write organization config for given organization. (PUT /api/v2/fax/settings) Requires permission directory:organization:admin. Required: sendEmailNotifications, disableEmailPii.
- **genesys_cloud_fax_settings_lookup** — Get organization config for given organization. (GET /api/v2/fax/settings)
- **genesys_cloud_fax_status_lookup** — Get fax status. Retrieves status for an outbound (sent) fax. Only the authenticated user who sent the fax can fetch its status; this operation does not expose inbound or other users' faxes. (GET /api/v2/fax/{faxId}/status) Requires permission conversation:fax:send. Required: fax_id.
- **genesys_cloud_fax_summary_lookup** — Get fax summary. (GET /api/v2/fax/summary)
- **create_a_genesys_cloud_flow_action_checkin** — Check-in flow. Asynchronous. Notification topic: v2.flows.{flowId}. (POST /api/v2/flows/actions/checkin) Requires any of permissions architect:flow:edit, architect:flow:unlock. Required: flow.
- **create_a_genesys_cloud_flow_action_checkout** — Check-out flow. (POST /api/v2/flows/actions/checkout) Requires permission architect:flow:edit. Required: flow.
- **genesys_cloud_flow_actions_deactivate** — Deactivate flow. (POST /api/v2/flows/actions/deactivate) Requires permission architect:flow:publish. Required: flow.
- **genesys_cloud_flow_actions_publish** — Publish flow. Asynchronous. Notification topic: v2.flows.{flowId}. (POST /api/v2/flows/actions/publish) Requires any of permissions architect:flow:unlock, architect:flow:publish. Required: flow.
- **genesys_cloud_flow_actions_revert** — Revert flow. (POST /api/v2/flows/actions/revert) Requires permission architect:flow:edit. Required: flow.
- **genesys_cloud_flow_actions_unlock** — Unlock flow. Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action. (POST /api/v2/flows/actions/unlock) Requires permission architect:flow:unlock. Required: flow.
- **get_single_genesys_cloud_flow_datatable_divisionview_by_id** — Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it. (GET /api/v2/flows/datatables/divisionviews/{datatableId}) Requires permission architect:datatable:search. The id is the datatableId. Required: id.
- **list_all_genesys_cloud_flow_datatable_divisionviews** — Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description. (GET /api/v2/flows/datatables/divisionviews) Requires permission architect:datatable:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_flow_datatable_export_job** — Begin an export process for exporting all rows from a datatable. Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response. (POST /api/v2/flows/datatables/{datatableId}/export/jobs) Requires any of permissions architect:datatable:view, architect:datatableRow:view. Required: datatable_id.
- **get_single_genesys_cloud_flow_datatable_export_job_by_id** — Returns the state information about an export job. (GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}) Requires any of permissions architect:datatable:view, architect:datatableRow:view. The id is the exportJobId. Required: id, datatable_id.
- **create_a_genesys_cloud_flow_datatable_import_csv_job** — Begin an import process for importing rows from a CSV file into a datatable. Create an import job for importing rows from a CSV file. The caller can then poll for status of the import using the token returned in the response. (POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs) Requires any of permissions architect:datatable:edit, architect:datatableRow:add. Required: datatable_id, status.
- **get_single_genesys_cloud_flow_datatable_import_job_by_id** — Returns the state information about an import job. (GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}) Requires any of permissions architect:datatable:view, architect:datatableRow:view. The id is the importJobId. Required: id, datatable_id.
- **list_all_genesys_cloud_flow_datatable_import_jobs** — Get all recent import jobs. (GET /api/v2/flows/datatables/{datatableId}/import/jobs) Requires any of permissions architect:datatable:edit, architect:datatableRow:view. Pages automatically with pageNumber/pageSize. Required: datatable_id.
- **create_a_genesys_cloud_flow_datatable_row** — Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. (POST /api/v2/flows/datatables/{datatableId}/rows) Requires any of permissions architect:datatable:add, architect:datatableRow:add. Required: datatable_id.
- **delete_a_genesys_cloud_flow_datatable_row_by_id** — Delete a row entry. Deletes a row with a given rowId (the value of the key field). (DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId}) Requires any of permissions architect:datatable:delete, architect:datatableRow:delete. The id is the rowId. Required: id, datatable_id.
- **get_single_genesys_cloud_flow_datatable_row_by_id** — Returns a specific row for the datatable. Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId. (GET /api/v2/flows/datatables/{datatableId}/rows/{rowId}) Requires any of permissions architect:datatable:view, architect:datatableRow:view. The id is the rowId. Required: id, datatable_id.
- **list_all_genesys_cloud_flow_datatable_rows** — Returns the rows for the datatable with the given id. Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents. (GET /api/v2/flows/datatables/{datatableId}/rows) Requires any of permissions architect:datatable:view, architect:datatableRow:view. Pages automatically with pageNumber/pageSize. Required: datatable_id.
- **update_a_genesys_cloud_flow_datatable_row_by_id** — Update a row entry. Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }. (PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId}) Requires any of permissions architect:datatable:edit, architect:datatableRow:edit. The id is the rowId. Required: id, datatable_id.
- **create_a_genesys_cloud_flow_datatable** — Create a new datatable with the specified json-schema definition. This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/. (POST /api/v2/flows/datatables) Requires permission architect:datatable:add.
- **delete_a_genesys_cloud_flow_datatable_by_id** — deletes a specific datatable by id. Deletes an entire datatable (including the schema and data) with a given datatableId. (DELETE /api/v2/flows/datatables/{datatableId}) Requires permission architect:datatable:delete. The id is the datatableId. Required: id.
- **get_single_genesys_cloud_flow_datatable_by_id** — Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it. (GET /api/v2/flows/datatables/{datatableId}) Requires permission architect:datatable:view. The id is the datatableId. Required: id.
- **list_all_genesys_cloud_flow_datatables** — Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description. (GET /api/v2/flows/datatables) Requires permission architect:datatable:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_flow_datatable_by_id** — Updates a specific datatable by id. Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields. (PUT /api/v2/flows/datatables/{datatableId}) Requires permission architect:datatable:edit. The id is the datatableId. Required: id.
- **list_all_genesys_cloud_flow_divisionviews** — Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/flows/divisionviews) Requires permission architect:flow:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_flow_execution** — Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need. (POST /api/v2/flows/executions) Requires permission architect:flow:launch. Required: flowId.
- **get_single_genesys_cloud_flow_execution_by_id** — Get a flow execution's details. Flow execution details are available for several days after the flow is started. (GET /api/v2/flows/executions/{flowExecutionId}) Requires permission architect:flowExecution:view. The id is the flowExecutionId. Required: id.
- **create_a_genesys_cloud_flow_export_job** — Register Architect Export Job. (POST /api/v2/flows/export/jobs) Requires permission architect:jobExport:create. Required: flows.
- **get_single_genesys_cloud_flow_export_job_by_id** — Fetch Architect Export Job Status. (GET /api/v2/flows/export/jobs/{jobId}) Requires permission architect:jobExport:view. The id is the jobId. Required: id.
- **create_a_genesys_cloud_flow_history** — Generate flow history. Asynchronous. Notification topic: v2.flows.{flowId}. (POST /api/v2/flows/{flowId}/history) Requires permission architect:flow:view. Required: flow_id.
- **get_single_genesys_cloud_flow_history_by_id** — Get generated flow history. (GET /api/v2/flows/{flowId}/history/{historyId}) Requires permission architect:flow:view. The id is the historyId. Required: id, flow_id.
- **create_a_genesys_cloud_flow_instance_job** — Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete. (POST /api/v2/flows/instances/jobs) Requires permission architect:flowInstance:view. Required: ids.
- **get_single_genesys_cloud_flow_instance_job_by_id** — Get the status and/or results of an asynchronous flow execution data retrieval job. (GET /api/v2/flows/instances/jobs/{jobId}) Requires permission architect:flowInstance:view. The id is the jobId. Required: id.
- **genesys_cloud_flow_instance_querycapabilities_lookup** — Retrieve a list of capabilities that the org can use to query for execution data. Returns the queryable parameters that can be used to build a query for execution data. (GET /api/v2/flows/instances/querycapabilities) Requires permission architect:flowInstance:search.
- **flow_instance_settings_executiondata_bulk_partial_update** — Edit the execution history enabled setting. (PATCH /api/v2/flows/instances/settings/executiondata) Requires permission architect:flowinstanceexecutiondata:edit. Required: enabled.
- **genesys_cloud_flow_instance_settings_executiondata_lookup** — Get the execution history enabled setting. (GET /api/v2/flows/instances/settings/executiondata) Requires permission architect:flowinstanceexecutiondata:view.
- **flow_instance_settings_loglevel_characteristics_lookup** — Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled. (GET /api/v2/flows/instances/settings/loglevels/characteristics) Requires any of permissions architect:flowLogLevel:view, architect:flowLogLevelDefault:view.
- **flow_instance_settings_loglevel_default_bulk_delete** — Resets the org log level to default, base. (DELETE /api/v2/flows/instances/settings/loglevels/default) Requires permission architect:flowLogLevelDefault:delete.
- **flow_instance_settings_loglevel_default_bulk_update** — Edit the flow default log level. (PUT /api/v2/flows/instances/settings/loglevels/default) Requires permission architect:flowLogLevelDefault:edit. Required: logLevelCharacteristics.
- **genesys_cloud_flow_instance_settings_loglevel_default_lookup** — Returns the flow default log level which will be used if no specific flow id log level is found. (GET /api/v2/flows/instances/settings/loglevels/default) Requires permission architect:flowLogLevelDefault:view.
- **genesys_cloud_flow_instance_settings_loglevels_bulk_delete** — Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow id. (DELETE /api/v2/flows/{flowId}/instances/settings/loglevels) Requires permission architect:flowLogLevel:delete. Required: flow_id.
- **genesys_cloud_flow_instance_settings_loglevels_bulk_update** — Edit the logLevel for a particular flow id. Updates the loglevel for a flow id. (PUT /api/v2/flows/{flowId}/instances/settings/loglevels) Requires permission architect:flowLogLevel:edit. Required: flow_id, logLevelCharacteristics.
- **create_a_genesys_cloud_flow_instance_settings_loglevel** — Set the logLevel for a particular flow id. Assigns a new loglevel to a flow id. (POST /api/v2/flows/{flowId}/instances/settings/loglevels) Requires permission architect:flowLogLevel:add. Required: flow_id, logLevelCharacteristics.
- **list_all_genesys_cloud_flow_instance_settings_loglevels** — Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id. (GET /api/v2/flows/instances/settings/loglevels) Requires permissions architect:flowLogLevel:view, architect:flow:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_flow_instance_settings_loglevels_lookup** — Retrieves the log level for a flow by flow id. (GET /api/v2/flows/{flowId}/instances/settings/loglevels) Requires permission architect:flowLogLevel:view. Required: flow_id.
- **get_single_genesys_cloud_flow_instance_by_id** — Start a process (job) to prepare a download of a singular flow execution data instance by Id. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete. (GET /api/v2/flows/instances/{instanceId}) Requires permission architect:flowInstance:view. The id is the instanceId. Required: id.
- **genesys_cloud_flow_instances_search** — Query the database of existing flow histories to look for particular flow criteria. Returns a list of matching flow histories up to 200 max. (POST /api/v2/flows/instances/query) Requires permission architect:flowInstance:search. Required: query.
- **create_a_genesys_cloud_flow_job** — Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job. (POST /api/v2/flows/jobs) Requires permission architect:job:create.
- **get_single_genesys_cloud_flow_job_by_id** — Fetch Architect Job Status. (GET /api/v2/flows/jobs/{jobId}) Requires permission architect:job:view. The id is the jobId. Required: id.
- **genesys_cloud_flow_latestconfiguration_lookup** — Get the latest configuration for flow. (GET /api/v2/flows/{flowId}/latestconfiguration) Requires permission architect:flow:view. Required: flow_id.
- **list_all_genesys_cloud_flow_lookup** — Look up flows by ID. Returns only flows matching the specified ID(s). Returns an empty listing if no flows match the given IDs. (GET /api/v2/flows/lookup) Requires permission architect:flow:view. Pages automatically with pageNumber/pageSize. Required: id.
- **list_all_genesys_cloud_flow_milestone_divisionviews** — Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/flows/milestones/divisionviews) Requires permission architect:flowMilestone:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_flow_milestone** — Create a flow milestone. (POST /api/v2/flows/milestones) Requires permission architect:flowMilestone:add. Required: name.
- **delete_a_genesys_cloud_flow_milestone_by_id** — Delete a flow milestone. (DELETE /api/v2/flows/milestones/{milestoneId}) Requires permission architect:flowMilestone:delete. The id is the milestoneId. Required: id.
- **get_single_genesys_cloud_flow_milestone_by_id** — Get a flow milestone. Returns a specified flow milestone. (GET /api/v2/flows/milestones/{milestoneId}) Requires permission architect:flowMilestone:view. The id is the milestoneId. Required: id.
- **list_all_genesys_cloud_flow_milestones** — Get a pageable list of flow milestones, filtered by query parameters. Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated. (GET /api/v2/flows/milestones) Requires permission architect:flowMilestone:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_flow_milestone_by_id** — Updates a flow milestone. (PUT /api/v2/flows/milestones/{milestoneId}) Requires permission architect:flowMilestone:edit. The id is the milestoneId. Required: id, name.
- **list_all_genesys_cloud_flow_outcome_divisionviews** — Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/flows/outcomes/divisionviews) Requires permission architect:flowOutcome:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_flow_outcome** — Create a flow outcome. Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}. (POST /api/v2/flows/outcomes) Requires permission architect:flowOutcome:add. Required: name.
- **get_single_genesys_cloud_flow_outcome_by_id** — Get a flow outcome. Returns a specified flow outcome. (GET /api/v2/flows/outcomes/{flowOutcomeId}) Requires permission architect:flowOutcome:view. The id is the flowOutcomeId. Required: id.
- **list_all_genesys_cloud_flow_outcomes** — Get a pageable list of flow outcomes, filtered by query parameters. Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated. (GET /api/v2/flows/outcomes) Requires permission architect:flowOutcome:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_flow_outcome_by_id** — Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId}. (PUT /api/v2/flows/outcomes/{flowOutcomeId}) Requires permission architect:flowOutcome:edit. The id is the flowOutcomeId. Required: id, name.
- **create_a_genesys_cloud_flow_validate_job** — Register Architect Validate Job. (POST /api/v2/flows/validate/jobs) Requires permission architect:jobValidate:create. Required: flows.
- **get_single_genesys_cloud_flow_validate_job_by_id** — Fetch Architect Validate Job Status. (GET /api/v2/flows/validate/jobs/{jobId}) Requires permission architect:jobValidate:view. The id is the jobId. Required: id.
- **genesys_cloud_flow_version_configuration_lookup** — Get flow version configuration. (GET /api/v2/flows/{flowId}/versions/{versionId}/configuration) Requires permission architect:flow:view. Required: flow_id, version_id.
- **genesys_cloud_flow_version_health_lookup** — Get overall health scores for all intents present in the NLU domain version associated with the bot flow version. (GET /api/v2/flows/{flowId}/versions/{versionId}/health) Requires permission architect:flow:view. Required: flow_id, version_id.
- **genesys_cloud_flow_version_intent_health_lookup** — Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent. (GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health) Requires permission architect:flow:view. Required: flow_id, version_id, intent_id, language.
- **genesys_cloud_flow_version_intent_utterance_health_lookup** — Get health metrics associated with a specific utterance of an intent. (GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health) Requires permission architect:flow:view. Required: flow_id, version_id, intent_id, utterance_id, language.
- **create_a_genesys_cloud_flow_version** — Create flow version. (POST /api/v2/flows/{flowId}/versions) Requires permission architect:flow:edit. Required: flow_id.
- **get_single_genesys_cloud_flow_version_by_id** — Get flow version. (GET /api/v2/flows/{flowId}/versions/{versionId}) Requires permission architect:flow:view. The id is the versionId. Required: id, flow_id.
- **list_all_genesys_cloud_flow_versions** — Get flow version list. (GET /api/v2/flows/{flowId}/versions) Requires permission architect:flow:view. Pages automatically with pageNumber/pageSize. Required: flow_id.
- **genesys_cloud_flows_bulk_delete** — Batch-delete a list of flows. Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}. (DELETE /api/v2/flows) Requires permission architect:flow:delete. Required: id.
- **create_a_genesys_cloud_flow** — Create flow. (POST /api/v2/flows) Requires permission architect:flow:add. Required: name.
- **delete_a_genesys_cloud_flow_by_id** — Delete flow. (DELETE /api/v2/flows/{flowId}) Requires permission architect:flow:delete. The id is the flowId. Required: id.
- **get_single_genesys_cloud_flow_by_id** — Get flow. (GET /api/v2/flows/{flowId}) Requires permission architect:flow:view. The id is the flowId. Required: id.
- **list_all_genesys_cloud_flows** — Get a pageable list of flows, filtered by query parameters. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/flows) Requires permission architect:flow:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_flow_by_id** — Update flow. (PUT /api/v2/flows/{flowId}) Requires permission architect:flow:edit. The id is the flowId. Required: id, name.
- **list_all_genesys_cloud_gamification_contest_agent_score_me** — Get Contest Scores for the requesting Agent/Supervisor. (GET /api/v2/gamification/contests/{contestId}/agents/scores/me) Requires permission gamification:contest:view. Pages automatically with pageNumber/pageSize. Required: contest_id.
- **genesys_cloud_gamification_contest_agent_score_trend_me_lookup** — Get a Contest Score Trend for the requesting Agent. (GET /api/v2/gamification/contests/{contestId}/agents/scores/trends/me) Requires permission gamification:contest:view. Required: contest_id.
- **list_all_genesys_cloud_gamification_contest_agent_score_trends** — Get a Contest Score Trend (Average Trend). (GET /api/v2/gamification/contests/{contestId}/agents/scores/trends) Requires permission gamification:contest:view. Required: contest_id.
- **list_all_genesys_cloud_gamification_contest_agent_scores** — Get Contest Scores (Admin). (GET /api/v2/gamification/contests/{contestId}/agents/scores) Requires permission gamification:contest:viewAll. Pages automatically with pageNumber/pageSize. Required: contest_id.
- **list_all_genesys_cloud_gamification_contest_me** — Get a List of Contests (Agent/Supervisor). (GET /api/v2/gamification/contests/me) Requires permission gamification:contest:view. Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_gamification_contest_prizeimage_by_id** — Get a Contest Prize Image by Id. (GET /api/v2/gamification/contests/{contestId}/prizeimages/{prizeImageId}) Requires any of permissions gamification:contest:view, gamification:contest:viewAll. The id is the prizeImageId. Required: id, contest_id.
- **create_a_genesys_cloud_gamification_contest_upload_prizeimage** — Generates pre-signed URL to upload a prize image for gamification contests. (POST /api/v2/gamification/contests/uploads/prizeimages) Requires permission gamification:contestPrizeImage:upload. Required: contentType, contentLength.
- **create_a_genesys_cloud_gamification_contest** — Creates a Contest. (POST /api/v2/gamification/contests) Requires permission gamification:contest:add. Required: title, description, dateStart, dateEnd, winningCriteria, dateAnnounced, announcementTimezone, anonymization, metrics, prizes, profileId, participantIds.
- **delete_a_genesys_cloud_gamification_contest_by_id** — Delete a Contest by Id. (DELETE /api/v2/gamification/contests/{contestId}) Requires any of permissions gamification:contest:delete, gamification:contest:deleteAll. The id is the contestId. Required: id.
- **get_single_genesys_cloud_gamification_contest_by_id** — Get a Contest by Id. (GET /api/v2/gamification/contests/{contestId}) Requires permission gamification:contest:view. The id is the contestId. Required: id.
- **list_all_genesys_cloud_gamification_contests** — Get a List of Contests (Admin). (GET /api/v2/gamification/contests) Requires permission gamification:contest:viewAll. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_gamification_contests_partial_update** — Finalize a Contest by Id. (PATCH /api/v2/gamification/contests/{contestId}) Requires any of permissions gamification:contestStatus:edit, gamification:contestStatus:editAll. Required: contest_id, status.
- **update_a_genesys_cloud_gamification_contest_by_id** — Update a Contest by Id. (PUT /api/v2/gamification/contests/{contestId}) Requires any of permissions gamification:contest:edit, gamification:contest:editAll. The id is the contestId. Required: id, title, description, dateStart, dateEnd, winningCriteria, dateAnnounced, announcementTimezone, anonymization, metrics, prizes, profileId, participantIds.
- **genesys_cloud_gamification_insight_details_lookup** — Get insights details for the current user. (GET /api/v2/gamification/insights/details) Requires permission gamification:insights:view. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday.
- **genesys_cloud_gamification_insight_group_trend_all_lookup** — Get insights overall trend. (GET /api/v2/gamification/insights/groups/trends/all) Requires permission gamification:insights:viewAll. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday.
- **genesys_cloud_gamification_insight_group_trends_lookup** — Get insights overall trend for the current user. (GET /api/v2/gamification/insights/groups/trends) Requires permission gamification:insights:view. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday.
- **genesys_cloud_gamification_insight_managers_lookup** — Query managers in a profile during a period of time. (GET /api/v2/gamification/insights/managers) Requires permission gamification:insights:viewAll. Required: filterType, filterId, granularity, startWorkday.
- **genesys_cloud_gamification_insight_members_lookup** — Query users in a profile during a period of time. (GET /api/v2/gamification/insights/members) Requires permission gamification:insights:viewAll. Required: filterType, filterId, granularity, startWorkday.
- **genesys_cloud_gamification_insight_rankings_lookup** — Get insights rankings. (GET /api/v2/gamification/insights/rankings) Requires permission gamification:insights:viewAll. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday, sortKey.
- **genesys_cloud_gamification_insight_trends_lookup** — Get insights user trend for the current user. (GET /api/v2/gamification/insights/trends) Requires permission gamification:insights:view. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday.
- **genesys_cloud_gamification_insight_user_details_lookup** — Get insights details for the user. (GET /api/v2/gamification/insights/users/{userId}/details) Requires permission gamification:insights:viewAll. Required: user_id, filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday.
- **genesys_cloud_gamification_insight_user_trends_lookup** — Get insights user trend for the user. (GET /api/v2/gamification/insights/users/{userId}/trends) Requires permission gamification:insights:viewAll. Required: user_id, filterType, filterId, granularity, comparativePeriodStartWorkday, comparativePeriodEndWorkday, primaryPeriodStartWorkday, primaryPeriodEndWorkday.
- **genesys_cloud_gamification_insights_lookup** — Get insights summary. (GET /api/v2/gamification/insights) Requires permission gamification:insights:viewAll. Required: filterType, filterId, granularity, comparativePeriodStartWorkday, primaryPeriodStartWorkday.
- **genesys_cloud_gamification_leaderboard_lookup** — Leaderboard of the requesting user's division or performance profile. (GET /api/v2/gamification/leaderboard) Requires permission gamification:leaderboard:view. Required: startWorkday, endWorkday.
- **genesys_cloud_gamification_leaderboard_all_lookup** — Leaderboard by filter type. (GET /api/v2/gamification/leaderboard/all) Requires permission gamification:leaderboard:viewAll. Required: filterType, filterId, startWorkday, endWorkday.
- **genesys_cloud_gamification_leaderboard_all_bestpoints_lookup** — Best Points by division or performance profile. (GET /api/v2/gamification/leaderboard/all/bestpoints) Requires permission gamification:leaderboard:viewAll. Required: filterType, filterId.
- **genesys_cloud_gamification_leaderboard_bestpoints_lookup** — Best Points of the requesting user's current performance profile or division. (GET /api/v2/gamification/leaderboard/bestpoints) Requires permission gamification:leaderboard:view.
- **get_single_genesys_cloud_gamification_metricdefinition_by_id** — Metric definition by id. (GET /api/v2/gamification/metricdefinitions/{metricDefinitionId}) Requires permission gamification:profile:view. The id is the metricDefinitionId. Required: id.
- **list_all_genesys_cloud_gamification_metricdefinitions** — All metric definitions. Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric. (GET /api/v2/gamification/metricdefinitions) Requires permission gamification:profile:view.
- **create_a_genesys_cloud_gamification_profile_member_validate** — Validate member assignment. (POST /api/v2/gamification/profiles/{profileId}/members/validate) Requires permission gamification:profile:update. Required: profile_id, membersToAssign.
- **create_a_genesys_cloud_gamification_profile_member** — Assign members to a given performance profile. (POST /api/v2/gamification/profiles/{profileId}/members) Requires permission gamification:profile:update. Required: profile_id, membersToAssign, membersToRemove.
- **list_all_genesys_cloud_gamification_profile_members** — Members of a given performance profile. (GET /api/v2/gamification/profiles/{profileId}/members) Requires permission gamification:profile:view. Required: profile_id.
- **create_a_genesys_cloud_gamification_profile_metric** — Creates a gamified metric with a given metric definition and metric objective under in a performance profile. (POST /api/v2/gamification/profiles/{profileId}/metrics) Requires permission gamification:profile:update. Required: profile_id, name.
- **get_single_genesys_cloud_gamification_profile_metric_by_id** — Performance profile gamified metric by id. (GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId}) Requires any of permissions gamification:profile:view, gamification:leaderboard:view, gamification:scorecard:view. The id is the metricId. Required: id, profile_id.
- **list_all_genesys_cloud_gamification_profile_metrics** — All gamified metrics for a given performance profile. (GET /api/v2/gamification/profiles/{profileId}/metrics) Requires any of permissions gamification:profile:view, gamification:leaderboard:view, gamification:scorecard:view. Required: profile_id.
- **update_a_genesys_cloud_gamification_profile_metric_by_id** — Updates a metric in performance profile. (PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId}) Requires permission gamification:profile:update. The id is the metricId. Required: id, profile_id, name.
- **create_a_genesys_cloud_gamification_profile_metrics_link** — Creates a linked metric. (POST /api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link) Requires permission gamification:profile:update. Required: source_profile_id, source_metric_id, targetPerformanceProfileId.
- **list_all_gamification_profile_metrics_objectivedetails** — All metrics for a given performance profile with objective details such as order and maxPoints. (GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails) Requires any of permissions gamification:profile:view, gamification:leaderboard:view, gamification:scorecard:view. Required: profile_id.
- **genesys_cloud_gamification_profile_user_me_lookup** — Performance profile of the requesting user. (GET /api/v2/gamification/profiles/users/me)
- **genesys_cloud_gamification_profile_user_me_search** — Query performance profiles in date range for the current user. (POST /api/v2/gamification/profiles/users/me/query) Required: startWorkday, endWorkday.
- **get_single_genesys_cloud_gamification_profile_user_by_id** — Performance profile of a user. (GET /api/v2/gamification/profiles/users/{userId}) Requires any of permissions gamification:profile:view, gamification:scorecard:viewAll, gamification:leaderboard:viewAll. The id is the userId. Required: id.
- **genesys_cloud_gamification_profile_users_search** — Query performance profiles in date range for a user. (POST /api/v2/gamification/profiles/users/{userId}/query) Requires permission gamification:agentProfileMembership:view. Required: user_id, startWorkday, endWorkday.
- **genesys_cloud_gamification_profiles_activate** — Activate a performance profile. (POST /api/v2/gamification/profiles/{profileId}/activate) Requires permission gamification:profile:update. Required: profile_id.
- **create_a_genesys_cloud_gamification_profile** — Create a new custom performance profile. (POST /api/v2/gamification/profiles) Requires permission gamification:profile:update. Required: name, division, description, reportingIntervals, active, maxLeaderboardRankSize.
- **genesys_cloud_gamification_profiles_deactivate** — Deactivate a performance profile. (POST /api/v2/gamification/profiles/{profileId}/deactivate) Requires permission gamification:profile:update. Required: profile_id.
- **get_single_genesys_cloud_gamification_profile_by_id** — Performance profile by id. (GET /api/v2/gamification/profiles/{profileId}) Requires any of permissions gamification:profile:view, gamification:leaderboard:viewAll, gamification:scorecard:viewAll. The id is the profileId. Required: id.
- **list_all_genesys_cloud_gamification_profiles** — All performance profiles. (GET /api/v2/gamification/profiles) Requires any of permissions gamification:profile:view, gamification:leaderboard:viewAll, gamification:scorecard:viewAll.
- **update_a_genesys_cloud_gamification_profile_by_id** — Updates a performance profile. (PUT /api/v2/gamification/profiles/{profileId}) Requires permission gamification:profile:update. The id is the profileId. Required: id, name, description, metricOrders.
- **list_all_genesys_cloud_gamification_scorecard_attendance** — Attendance status metrics of the requesting user. (GET /api/v2/gamification/scorecards/attendance) Requires permission gamification:scorecard:view. Required: startWorkday, endWorkday.
- **genesys_cloud_gamification_scorecard_bestpoints_lookup** — Best points of the requesting user. (GET /api/v2/gamification/scorecards/bestpoints) Requires permission gamification:scorecard:view.
- **gamification_scorecard_metrics_user_value_trends_by_user_lookup** — Average performance values trends by metric of a user. (GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends) Requires permission gamification:scorecard:viewAll. Required: profile_id, metric_id, user_id, startWorkday, endWorkday.
- **genesys_cloud_gamification_scorecard_point_alltime_lookup** — All-time points of the requesting user. (GET /api/v2/gamification/scorecards/points/alltime) Requires permission gamification:scorecard:view. Required: endWorkday.
- **genesys_cloud_gamification_scorecard_point_average_lookup** — Average points of the requesting user's division or performance profile. (GET /api/v2/gamification/scorecards/points/average) Requires permission gamification:scorecard:view. Required: workday.
- **genesys_cloud_gamification_scorecard_point_trends_lookup** — Points trends of the requesting user. (GET /api/v2/gamification/scorecards/points/trends) Requires permission gamification:scorecard:view. Required: startWorkday, endWorkday.
- **gamification_scorecard_profile_metrics_user_value_trends_lookup** — Average performance values trends by metric of a division or a performance profile. (GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends) Requires permission gamification:scorecard:viewAll. Required: profile_id, metric_id, filterType, startWorkday, endWorkday.
- **gamification_scorecard_profile_metrics_value_trends_lookup** — Average performance values trends by metric of the requesting user. (GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends) Requires permission gamification:scorecard:view. Required: profile_id, metric_id, startWorkday, endWorkday.
- **list_all_genesys_cloud_gamification_scorecard_user_attendance** — Attendance status metrics for a user. (GET /api/v2/gamification/scorecards/users/{userId}/attendance) Requires permission gamification:scorecard:viewAll. Required: user_id, startWorkday, endWorkday.
- **genesys_cloud_gamification_scorecard_user_bestpoints_lookup** — Best points of a user. (GET /api/v2/gamification/scorecards/users/{userId}/bestpoints) Requires permission gamification:scorecard:viewAll. Required: user_id.
- **genesys_cloud_gamification_scorecard_user_point_alltime_lookup** — All-time points for a user. (GET /api/v2/gamification/scorecards/users/{userId}/points/alltime) Requires permission gamification:scorecard:viewAll. Required: user_id, endWorkday.
- **genesys_cloud_gamification_scorecard_user_point_average_lookup** — Workday average points by target group. (GET /api/v2/gamification/scorecards/users/points/average) Requires permission gamification:scorecard:viewAll. Required: filterType, filterId, workday.
- **genesys_cloud_gamification_scorecard_user_point_trends_lookup** — Points trend for a user. (GET /api/v2/gamification/scorecards/users/{userId}/points/trends) Requires permission gamification:scorecard:viewAll. Required: user_id, startWorkday, endWorkday.
- **genesys_cloud_gamification_scorecard_user_value_average_lookup** — Workday average values by target group. (GET /api/v2/gamification/scorecards/users/values/average) Requires permission gamification:scorecard:viewAll. Required: filterType, filterId, workday.
- **genesys_cloud_gamification_scorecard_user_value_trends_lookup** — Values trend by target group. (GET /api/v2/gamification/scorecards/users/values/trends) Requires permission gamification:scorecard:viewAll. Required: filterType, filterId, startWorkday, endWorkday.
- **gamification_scorecard_user_value_trends_by_user_lookup** — Values trends of a user. (GET /api/v2/gamification/scorecards/users/{userId}/values/trends) Requires permission gamification:scorecard:viewAll. Required: user_id, startWorkday, endWorkday.
- **get_single_genesys_cloud_gamification_scorecard_user_by_id** — Workday performance metrics for a user. (GET /api/v2/gamification/scorecards/users/{userId}) Requires permission gamification:scorecard:viewAll. The id is the userId. Required: id, workday.
- **genesys_cloud_gamification_scorecard_value_average_lookup** — Average values of the requesting user's division or performance profile. (GET /api/v2/gamification/scorecards/values/average) Requires permission gamification:scorecard:view. Required: workday.
- **genesys_cloud_gamification_scorecard_value_trends_lookup** — Values trends of the requesting user or group. (GET /api/v2/gamification/scorecards/values/trends) Requires permission gamification:scorecard:view. Required: startWorkday, endWorkday.
- **list_all_genesys_cloud_gamification_scorecards** — Workday performance metrics of the requesting user. (GET /api/v2/gamification/scorecards) Requires permission gamification:scorecard:view. Required: workday.
- **genesys_cloud_gamification_status_bulk_update** — Update gamification activation status. (PUT /api/v2/gamification/status) Requires permission gamification:profile:update.
- **genesys_cloud_gamification_status_lookup** — Gamification activation status. (GET /api/v2/gamification/status) Requires any of permissions gamification:profile:view, gamification:profile:update, gamification:scorecard:view.
- **get_single_genesys_cloud_gamification_template_by_id** — Objective template by id. (GET /api/v2/gamification/templates/{templateId}) Requires permission gamification:profile:view. The id is the templateId. Required: id.
- **list_all_genesys_cloud_gamification_templates** — All objective templates. (GET /api/v2/gamification/templates) Requires permission gamification:profile:view.
- **create_a_genesys_cloud_gdpr_request** — Submit a new GDPR request. (POST /api/v2/gdpr/requests) Requires permission gdpr:request:add. Required: requestType, subject.
- **get_single_genesys_cloud_gdpr_request_by_id** — Get an existing GDPR request. (GET /api/v2/gdpr/requests/{requestId}) Requires permission gdpr:request:view. The id is the requestId. Required: id.
- **list_all_genesys_cloud_gdpr_requests** — Get all GDPR requests. (GET /api/v2/gdpr/requests) Requires permission gdpr:request:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_gdpr_subjects** — Get GDPR subjects. (GET /api/v2/gdpr/subjects) Requires permission gdpr:subject:view. Required: searchType, searchValue.
- **genesys_cloud_geolocation_settings_bulk_partial_update** — Patch a organization's GeolocationSettings. (PATCH /api/v2/geolocations/settings) Requires permission geolocation:settings:edit.
- **genesys_cloud_geolocation_settings_lookup** — Get a organization's GeolocationSettings. (GET /api/v2/geolocations/settings)
- **genesys_cloud_greeting_defaults_bulk_update** — Update an Organization's DefaultGreetingList. (PUT /api/v2/greetings/defaults)
- **genesys_cloud_greeting_defaults_lookup** — Get an Organization's DefaultGreetingList. (GET /api/v2/greetings/defaults)
- **genesys_cloud_greeting_downloads_lookup** — Download a organization greeting recording. (GET /api/v2/greetings/{greetingId}/downloads) Requires permission greetings:greeting:download. Required: greeting_id.
- **genesys_cloud_greeting_group_downloads_lookup** — Download a group greeting recording. (GET /api/v2/greetings/{greetingId}/groups/downloads) Requires permission greetings:groupGreeting:download. Required: greeting_id.
- **genesys_cloud_greeting_media_lookup** — Get media playback URI for this greeting. API should migrate to use GET api/v2/greetings/{greetingId}/downloads. (GET /api/v2/greetings/{greetingId}/media) Required: greeting_id.
- **genesys_cloud_greeting_user_downloads_lookup** — Download a user greeting recording. (GET /api/v2/greetings/{greetingId}/users/downloads) Requires permission greetings:greeting:download. Required: greeting_id.
- **create_a_genesys_cloud_greeting** — Create a Greeting for an Organization. (POST /api/v2/greetings) Required: type, ownerType, owner.
- **delete_a_genesys_cloud_greeting_by_id** — Deletes a Greeting with the given GreetingId. (DELETE /api/v2/greetings/{greetingId}) The id is the greetingId. Required: id.
- **get_single_genesys_cloud_greeting_by_id** — Get a Greeting with the given GreetingId. (GET /api/v2/greetings/{greetingId}) The id is the greetingId. Required: id.
- **list_all_genesys_cloud_greetings** — Gets an Organization's Greetings. (GET /api/v2/greetings) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_greeting_by_id** — Updates the Greeting with the given GreetingId. (PUT /api/v2/greetings/{greetingId}) The id is the greetingId. Required: id, type, ownerType, owner.
- **genesys_cloud_group_greeting_defaults_bulk_update** — Updates the DefaultGreetingList of the specified Group. (PUT /api/v2/groups/{groupId}/greetings/defaults) Required: group_id.
- **genesys_cloud_group_greeting_defaults_lookup** — Grabs the list of Default Greetings given a Group's ID. (GET /api/v2/groups/{groupId}/greetings/defaults) Required: group_id.
- **create_a_genesys_cloud_group_greeting** — Creates a Greeting for a Group. (POST /api/v2/groups/{groupId}/greetings) Required: group_id, type, ownerType, owner.
- **list_all_genesys_cloud_group_greetings** — Get a list of the Group's Greetings. (GET /api/v2/groups/{groupId}/greetings) Pages automatically with pageNumber/pageSize. Required: group_id.
- **list_all_genesys_cloud_group_individuals** — Get all individuals associated with the group. (GET /api/v2/groups/{groupId}/individuals) Required: group_id.
- **genesys_cloud_group_members_bulk_delete** — Remove members. (DELETE /api/v2/groups/{groupId}/members) Required: group_id, ids.
- **create_a_genesys_cloud_group_member** — Add members. (POST /api/v2/groups/{groupId}/members) Required: group_id, memberIds.
- **list_all_genesys_cloud_group_members** — Get group members, includes individuals, owners, and dynamically included people. (GET /api/v2/groups/{groupId}/members) Pages automatically with pageNumber/pageSize. Required: group_id.
- **genesys_cloud_group_search_lookup** — Search groups using the q64 value returned from a previous search. (GET /api/v2/groups/search) Required: q64.
- **create_a_genesys_cloud_group** — Create a group. (POST /api/v2/groups) Requires permission directory:group:add. Required: name, type, rulesVisible, visibility.
- **delete_a_genesys_cloud_group_by_id** — Delete group. (DELETE /api/v2/groups/{groupId}) Requires permission directory:group:delete. The id is the groupId. Required: id.
- **get_single_genesys_cloud_group_by_id** — Get group. (GET /api/v2/groups/{groupId}) The id is the groupId. Required: id.
- **list_all_genesys_cloud_groups** — Get a group list. (GET /api/v2/groups) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_groups_search** — Search groups. (POST /api/v2/groups/search)
- **update_a_genesys_cloud_group_by_id** — Update group. (PUT /api/v2/groups/{groupId}) Requires permission directory:group:edit. The id is the groupId. Required: id, version.
- **genesys_cloud_guide_jobs_bulk_delete** — Start the deletion of a guide. (DELETE /api/v2/guides/{guideId}/jobs) Requires permission aiStudio:guideJob:add. Required: guide_id.
- **create_a_genesys_cloud_guide_job** — Start a guide content generation job. (POST /api/v2/guides/jobs) Requires permission aiStudio:guideJob:add.
- **get_single_genesys_cloud_guide_job_by_id** — Get the status of the guide content generation job. (GET /api/v2/guides/jobs/{jobId}) Requires permission aiStudio:guideJob:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_guide_jobs_by_guide_by_id** — Get the specified guide deletion job. (GET /api/v2/guides/{guideId}/jobs/{jobId}) Requires permission aiStudio:guideJob:view. The id is the jobId. Required: id, guide_id.
- **create_a_genesys_cloud_guide_session_turn** — Add a turn to a guide session. Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically. (POST /api/v2/guides/{guideId}/sessions/{guideSessionId}/turns) Requires permission aiStudio:guideSessionTurn:add. Required: guide_id, guide_session_id, inputEvent, languageCode, version.
- **create_a_genesys_cloud_guide_upload** — Generate presigned URL for uploading a file content to generate guide. (POST /api/v2/guides/uploads) Requires permission aiStudio:guide:upload.
- **create_a_genesys_cloud_guide_version_job** — Start the publishing of a guide version. (POST /api/v2/guides/{guideId}/versions/{versionId}/jobs) Requires permission aiStudio:guideVersionJob:add. Required: guide_id, version_id, guideVersion.
- **get_single_genesys_cloud_guide_version_job_by_id** — Get the status of the publishing job for this guide version. (GET /api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}) Requires permission aiStudio:guideVersionJob:view. The id is the jobId. Required: id, guide_id, version_id.
- **create_a_genesys_cloud_guide_version** — Create a guide version. (POST /api/v2/guides/{guideId}/versions) Requires permission aiStudio:guideVersion:add. Required: guide_id, instruction.
- **get_single_genesys_cloud_guide_version_by_id** — Get a guide version. (GET /api/v2/guides/{guideId}/versions/{versionId}) Requires permission aiStudio:guideVersion:view. The id is the versionId. Required: id, guide_id.
- **update_a_genesys_cloud_guide_version_by_id** — Update a guide version. (PATCH /api/v2/guides/{guideId}/versions/{versionId}) Requires permission aiStudio:guideVersion:edit. The id is the versionId. Required: id, guide_id.
- **create_a_genesys_cloud_guide** — Create a guide. (POST /api/v2/guides) Requires permission aiStudio:guide:add. Required: name, source.
- **get_single_genesys_cloud_guide_by_id** — Get guide. (GET /api/v2/guides/{guideId}) Requires permission aiStudio:guide:view. The id is the guideId. Required: id.
- **list_all_genesys_cloud_guides** — Get all guides. (GET /api/v2/guides) Requires permission aiStudio:guide:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_guide_by_id** — Update a guide. (PATCH /api/v2/guides/{guideId}) Requires permission aiStudio:guide:edit. The id is the guideId. Required: id.
- **genesys_cloud_identityprovider_adfs_bulk_delete** — Delete ADFS Identity Provider. (DELETE /api/v2/identityproviders/adfs) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_adfs_bulk_update** — Update/Create ADFS Identity Provider. (PUT /api/v2/identityproviders/adfs) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_adfs_lookup** — Get ADFS Identity Provider. (GET /api/v2/identityproviders/adfs) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_cic_bulk_delete** — Delete Customer Interaction Center (CIC) Identity Provider. (DELETE /api/v2/identityproviders/cic) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_cic_bulk_update** — Update/Create Customer Interaction Center (CIC) Identity Provider. (PUT /api/v2/identityproviders/cic) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_cic_lookup** — Get Customer Interaction Center (CIC) Identity Provider. (GET /api/v2/identityproviders/cic) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_generic_bulk_delete** — Delete Generic SAML Identity Provider. (DELETE /api/v2/identityproviders/generic) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_generic_bulk_update** — Update/Create Generic SAML Identity Provider. (PUT /api/v2/identityproviders/generic) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_generic_lookup** — Get Generic SAML Identity Provider. (GET /api/v2/identityproviders/generic) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_gsuite_bulk_delete** — Delete G Suite Identity Provider. (DELETE /api/v2/identityproviders/gsuite) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_gsuite_bulk_update** — Update/Create G Suite Identity Provider. (PUT /api/v2/identityproviders/gsuite) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_gsuite_lookup** — Get G Suite Identity Provider. (GET /api/v2/identityproviders/gsuite) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_identitynow_bulk_delete** — Delete IdentityNow Provider. (DELETE /api/v2/identityproviders/identitynow) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_identitynow_bulk_update** — Update/Create IdentityNow Provider. (PUT /api/v2/identityproviders/identitynow) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_identitynow_lookup** — Get IdentityNow Provider. (GET /api/v2/identityproviders/identitynow) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_okta_bulk_delete** — Delete Okta Identity Provider. (DELETE /api/v2/identityproviders/okta) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_okta_bulk_update** — Update/Create Okta Identity Provider. (PUT /api/v2/identityproviders/okta) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_okta_lookup** — Get Okta Identity Provider. (GET /api/v2/identityproviders/okta) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_onelogin_bulk_delete** — Delete OneLogin Identity Provider. (DELETE /api/v2/identityproviders/onelogin) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_onelogin_bulk_update** — Update/Create OneLogin Identity Provider. (PUT /api/v2/identityproviders/onelogin) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_onelogin_lookup** — Get OneLogin Identity Provider. (GET /api/v2/identityproviders/onelogin) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_ping_bulk_delete** — Delete Ping Identity Provider. (DELETE /api/v2/identityproviders/ping) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_ping_bulk_update** — Update/Create Ping Identity Provider. (PUT /api/v2/identityproviders/ping) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_ping_lookup** — Get Ping Identity Provider. (GET /api/v2/identityproviders/ping) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_purecloud_bulk_delete** — Delete PureCloud Identity Provider. (DELETE /api/v2/identityproviders/purecloud) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_purecloud_bulk_update** — Update/Create PureCloud Identity Provider. (PUT /api/v2/identityproviders/purecloud) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_purecloud_lookup** — Get PureCloud Identity Provider. (GET /api/v2/identityproviders/purecloud) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_pureengage_bulk_delete** — Delete PureEngage Identity Provider. (DELETE /api/v2/identityproviders/pureengage) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_pureengage_bulk_update** — Update/Create PureEngage Identity Provider. (PUT /api/v2/identityproviders/pureengage) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_pureengage_lookup** — Get PureEngage Identity Provider. (GET /api/v2/identityproviders/pureengage) Requires permission sso:provider:view.
- **genesys_cloud_identityprovider_salesforce_bulk_delete** — Delete Salesforce Identity Provider. (DELETE /api/v2/identityproviders/salesforce) Requires permission sso:provider:delete.
- **genesys_cloud_identityprovider_salesforce_bulk_update** — Update/Create Salesforce Identity Provider. (PUT /api/v2/identityproviders/salesforce) Requires any of permissions sso:provider:add, sso:provider:edit.
- **genesys_cloud_identityprovider_salesforce_lookup** — Get Salesforce Identity Provider. (GET /api/v2/identityproviders/salesforce) Requires permission sso:provider:view.
- **create_a_genesys_cloud_identityprovider** — Create Identity Provider. (POST /api/v2/identityproviders) Requires permission sso:provider:add.
- **delete_a_genesys_cloud_identityprovider_by_id** — Delete Identity Provider. (DELETE /api/v2/identityproviders/{providerId}) Requires permission sso:provider:delete. The id is the providerId. Required: id.
- **get_single_genesys_cloud_identityprovider_by_id** — Get Identity Provider. (GET /api/v2/identityproviders/{providerId}) Requires permission sso:provider:view. The id is the providerId. Required: id.
- **list_all_genesys_cloud_identityproviders** — The list of identity providers. (GET /api/v2/identityproviders) Requires permission sso:provider:view.
- **update_a_genesys_cloud_identityprovider_by_id** — Update Identity Provider. (PUT /api/v2/identityproviders/{providerId}) Requires permission sso:provider:edit. The id is the providerId. Required: id.
- **get_single_genesys_cloud_infrastructureascode_accelerator_by_id** — Get information about an accelerator. Get the complete metadata specification for an accelerator, including requirements and parameters. (GET /api/v2/infrastructureascode/accelerators/{acceleratorId}) Requires permission infrastructureascode:accelerator:view. The id is the acceleratorId. Required: id.
- **list_all_genesys_cloud_infrastructureascode_accelerators** — Get a list of available accelerators. Search for accelerators that can be run. (GET /api/v2/infrastructureascode/accelerators) Requires permission infrastructureascode:accelerator:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_infrastructureascode_job** — Create a Job. Create and submit a job for remote execution or see job planning results. (POST /api/v2/infrastructureascode/jobs) Requires permission infrastructureascode:job:add. Required: acceleratorId.
- **get_single_genesys_cloud_infrastructureascode_job_by_id** — Get job status and results. Get the execution status of a submitted job, optionally including results and error details. (GET /api/v2/infrastructureascode/jobs/{jobId}) Requires permission infrastructureascode:job:view. The id is the jobId. Required: id.
- **genesys_cloud_infrastructureascode_jobs_lookup** — Get job history. Get a history of submitted jobs, optionally including error messages. (GET /api/v2/infrastructureascode/jobs) Requires permission infrastructureascode:job:view.
- **list_all_genesys_cloud_integration_action_categories** — Retrieves all categories of available Actions. (GET /api/v2/integrations/actions/categories) Requires any of permissions integrations:action:view, bridge:actions:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_integration_action_certificate_truststore** — Retrieves basic info about trusted root CA certificates. (GET /api/v2/integrations/actions/certificates/truststore) Requires permission integrations:actionCertificate:view.
- **list_all_genesys_cloud_integration_action_certificates** — Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress. (GET /api/v2/integrations/actions/certificates) Requires permission integrations:actionCertificate:view.
- **genesys_cloud_integration_action_current_draft_bulk_delete** — Delete a Draft. (DELETE /api/v2/integrations/actions/{actionId}/draft) Requires permission integrations:action:delete. Required: action_id.
- **integration_action_current_draft_bulk_partial_update** — Update an existing Draft. (PATCH /api/v2/integrations/actions/{actionId}/draft) Requires permission integrations:action:edit. Required: action_id, version.
- **create_a_genesys_cloud_integration_action_current_draft** — Create a new Draft from existing Action. (POST /api/v2/integrations/actions/{actionId}/draft) Requires permission integrations:action:edit. Required: action_id.
- **genesys_cloud_integration_action_current_draft_lookup** — Retrieve a Draft. (GET /api/v2/integrations/actions/{actionId}/draft) Requires any of permissions integrations:action:view, bridge:actions:view. Required: action_id.
- **genesys_cloud_integration_action_current_draft_publish** — Publish a Draft and make it the active Action configuration. (POST /api/v2/integrations/actions/{actionId}/draft/publish) Requires permission integrations:action:edit. Required: action_id, version.
- **genesys_cloud_integration_action_draft_function_bulk_update** — Update draft function settings. (PUT /api/v2/integrations/actions/{actionId}/draft/function) Requires permission integrations:actionFunction:edit. Required: action_id, description, handler, runtime.
- **genesys_cloud_integration_action_draft_function_lookup** — Get draft function settings for Action. (GET /api/v2/integrations/actions/{actionId}/draft/function) Requires permission integrations:actionFunction:view. Required: action_id.
- **create_a_genesys_cloud_integration_action_draft_function_upload** — Create upload presigned URL for draft function package file. (POST /api/v2/integrations/actions/{actionId}/draft/function/upload) Requires permission integrations:actionFunction:edit. Required: action_id, fileName.
- **get_single_genesys_cloud_integration_action_draft_schema_by_id** — Retrieve schema for a Draft based on filename. (GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the fileName. Required: id, action_id.
- **get_single_genesys_cloud_integration_action_draft_template_by_id** — Retrieve templates for a Draft based on filename. (GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the fileName. Required: id, action_id.
- **create_a_genesys_cloud_integration_action_draft_test** — Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging. (POST /api/v2/integrations/actions/{actionId}/draft/test) Requires permission integrations:action:execute. Required: action_id.
- **genesys_cloud_integration_action_draft_validation_lookup** — Validate current Draft configuration. (GET /api/v2/integrations/actions/{actionId}/draft/validation) Requires permission integrations:action:edit. Required: action_id.
- **create_a_genesys_cloud_integration_action_draft** — Create a new Draft. (POST /api/v2/integrations/actions/drafts) Requires permission integrations:action:add. Required: category, name, integrationId, config, contract.
- **list_all_genesys_cloud_integration_action_drafts** — Retrieves all action drafts associated with the filters passed in via query param. (GET /api/v2/integrations/actions/drafts) Requires any of permissions integrations:action:view, bridge:actions:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_integration_action_function_lookup** — Get published function settings for Action. (GET /api/v2/integrations/actions/{actionId}/function) Requires permission integrations:actionFunction:view. Required: action_id.
- **list_all_genesys_cloud_integration_action_function_runtimes** — Get action function settings for Action. (GET /api/v2/integrations/actions/functions/runtimes) Requires permission integrations:actionFunction:view.
- **get_single_genesys_cloud_integration_action_schema_by_id** — Retrieve schema for an action based on filename. (GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the fileName. Required: id, action_id.
- **get_single_genesys_cloud_integration_action_template_by_id** — Retrieve text of templates for an action based on filename. (GET /api/v2/integrations/actions/{actionId}/templates/{fileName}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the fileName. Required: id, action_id.
- **create_a_genesys_cloud_integration_action_test** — Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging. (POST /api/v2/integrations/actions/{actionId}/test) Requires any of permissions integrations:action:execute, bridge:actions:execute. Required: action_id.
- **create_a_genesys_cloud_integration_action** — Create a new Action. Not supported for 'Function Integration' actions. (POST /api/v2/integrations/actions) Requires permission integrations:action:add. Required: category, name, integrationId, config, contract.
- **delete_a_genesys_cloud_integration_action_by_id** — Delete an Action. (DELETE /api/v2/integrations/actions/{actionId}) Requires permission integrations:action:delete. The id is the actionId. Required: id.
- **genesys_cloud_integration_actions_execute** — Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error. (POST /api/v2/integrations/actions/{actionId}/execute) Requires any of permissions integrations:action:execute, bridge:actions:execute. Required: action_id.
- **get_single_genesys_cloud_integration_action_by_id** — Retrieves a single Action matching id. (GET /api/v2/integrations/actions/{actionId}) Requires any of permissions integrations:action:view, bridge:actions:view. The id is the actionId. Required: id.
- **list_all_genesys_cloud_integration_actions** — Retrieves all actions associated with filters passed in via query param. (GET /api/v2/integrations/actions) Requires any of permissions integrations:action:view, bridge:actions:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_integration_action_by_id** — Patch an Action. (PATCH /api/v2/integrations/actions/{actionId}) Requires permission integrations:action:edit. The id is the actionId. Required: id, version.
- **list_all_genesys_cloud_integration_botconnector_bot_summaries** — Get a summary list of botConnector bots for this integration. (GET /api/v2/integrations/botconnector/{integrationId}/bots/summaries) Requires permission integration:botconnector:view. Pages automatically with pageNumber/pageSize. Required: integration_id.
- **list_all_genesys_cloud_integration_botconnector_bot_versions** — Get a list of bot versions for a bot. (GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions) Requires permission integration:botconnector:view. Pages automatically with pageNumber/pageSize. Required: integration_id, bot_id.
- **genesys_cloud_integration_botconnector_bots_bulk_update** — Set a list of botConnector bots plus versions for this integration. (PUT /api/v2/integrations/botconnector/{integrationId}/bots) Requires permission integration:botconnector:edit. Required: integration_id, chatBots.
- **get_single_genesys_cloud_integration_botconnector_bot_by_id** — Get a specific botConnector bot, plus versions, for this integration. (GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId}) Requires permission integration:botconnector:view. The id is the botId. Required: id, integration_id.
- **list_all_genesys_cloud_integration_botconnector_bots** — Get a list of botConnector bots for this integration. (GET /api/v2/integrations/botconnector/{integrationId}/bots) Requires permission integration:botconnector:view. Required: integration_id.
- **list_all_genesys_cloud_integration_clientapps** — List permitted client app integrations for the logged in user. (GET /api/v2/integrations/clientapps) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_integration_config_current_bulk_update** — Update integration configuration. (PUT /api/v2/integrations/{integrationId}/config/current) Requires permission integrations:integration:edit. Required: integration_id, name, version, properties, advanced, notes, credentials.
- **genesys_cloud_integration_config_current_lookup** — Get integration configuration. (GET /api/v2/integrations/{integrationId}/config/current) Requires permission integrations:integration:view. Required: integration_id.
- **list_all_genesys_cloud_integration_credential_listing** — List multiple sets of credentials using cursor-based paging. (GET /api/v2/integrations/credentials/listing) Requires permission integrations:integration:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_integration_credential_types** — List all credential types. (GET /api/v2/integrations/credentials/types) Requires permission integrations:integration:view.
- **create_a_genesys_cloud_integration_credential** — Create a set of credentials. (POST /api/v2/integrations/credentials) Requires permission integrations:integration:add. Required: type.
- **delete_a_genesys_cloud_integration_credential_by_id** — Delete a set of credentials. (DELETE /api/v2/integrations/credentials/{credentialId}) Requires permission integrations:integration:delete. The id is the credentialId. Required: id.
- **get_single_genesys_cloud_integration_credential_by_id** — Get a single credential with sensitive fields redacted. (GET /api/v2/integrations/credentials/{credentialId}) Requires permission integrations:integration:view. The id is the credentialId. Required: id.
- **update_a_genesys_cloud_integration_credential_by_id** — Update a set of credentials. (PUT /api/v2/integrations/credentials/{credentialId}) Requires permission integrations:integration:edit. The id is the credentialId. Required: id, type.
- **get_single_genesys_cloud_integration_speech_audioconnector_by_id** — Get an Audio Connector integration. (GET /api/v2/integrations/speech/audioconnector/{integrationId}) Requires permission integrations:integration:view. The id is the integrationId. Required: id.
- **list_all_genesys_cloud_integration_speech_audioconnector** — Get a list of Audio Connector integrations. (GET /api/v2/integrations/speech/audioconnector) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_integration_speech_dialogflow_agent_by_id** — Get details about a Dialogflow agent. (GET /api/v2/integrations/speech/dialogflow/agents/{agentId}) Requires permission integrations:integration:view. The id is the agentId. Required: id.
- **list_all_genesys_cloud_integration_speech_dialogflow_agents** — Get a list of Dialogflow agents in the customers' Google accounts. (GET /api/v2/integrations/speech/dialogflow/agents) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_integration_speech_dialogflowcx_agent_by_id** — Get details about a Dialogflow CX agent. (GET /api/v2/integrations/speech/dialogflowcx/agents/{agentId}) Requires permission integrations:integration:view. The id is the agentId. Required: id.
- **list_all_genesys_cloud_integration_speech_dialogflowcx_agents** — Get a list of Dialogflow CX agents in the customers' Google accounts. (GET /api/v2/integrations/speech/dialogflowcx/agents) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_integration_speech_lex_bot_alias_by_id** — Get details about a Lex bot alias. (GET /api/v2/integrations/speech/lex/bot/alias/{aliasId}) Requires permission integrations:integration:view. The id is the aliasId. Required: id.
- **list_all_genesys_cloud_integration_speech_lex_bot_aliases** — Get a list of aliases for a bot in the customer's AWS accounts. (GET /api/v2/integrations/speech/lex/bot/{botId}/aliases) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize. Required: bot_id.
- **list_all_genesys_cloud_integration_speech_lex_bots** — Get a list of Lex bots in the customers' AWS accounts. (GET /api/v2/integrations/speech/lex/bots) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_integration_speech_lexv_2_bot_alias_by_id** — Get details about a Lex V2 bot alias. (GET /api/v2/integrations/speech/lexv2/bot/alias/{aliasId}) Requires permission integrations:integration:view. The id is the aliasId. Required: id.
- **list_all_genesys_cloud_integration_speech_lexv_2_bot_aliases** — Get a list of aliases for a Lex V2 bot. (GET /api/v2/integrations/speech/lexv2/bot/{botId}/aliases) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize. Required: bot_id.
- **list_all_genesys_cloud_integration_speech_lexv_2_bots** — Get a list of Lex V2 bots. (GET /api/v2/integrations/speech/lexv2/bots) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_integration_speech_nuance_bot_job_results** — Get the result of an asynchronous Nuance bots GET job. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results) Requires permission integrations:integration:view. Required: nuance_integration_id, job_id.
- **genesys_cloud_integration_speech_nuance_bot_job_results_lookup** — Get the result of an asynchronous Nuance bot GET job. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results) Requires permission integrations:integration:view. Required: nuance_integration_id, bot_id, job_id.
- **create_a_genesys_cloud_integration_speech_nuance_bot_job** — Get a list of Nuance bots in the specified Integration asynchronously. (POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs) Requires permission integrations:integration:view. Required: nuance_integration_id.
- **get_single_genesys_cloud_integration_speech_nuance_bot_job_by_id** — Get the status of an asynchronous Nuance bots GET job. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}) Requires permission integrations:integration:view. The id is the jobId. Required: id, nuance_integration_id.
- **create_a_genesys_cloud_integration_speech_nuance_bot_jobs_by_bot** — Get a Nuance bot in the specified Integration asynchronously. (POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs) Requires permission integrations:integration:view. Required: nuance_integration_id, bot_id.
- **get_integration_speech_nuance_bot_jobs_by_bot_by_id** — Get the status of an asynchronous Nuance bot GET job. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}) Requires permission integrations:integration:view. The id is the jobId. Required: id, nuance_integration_id, bot_id.
- **integration_speech_nuance_bot_launch_settings_bulk_update** — Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration. (PUT /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings) Requires permission integrations:integration:edit. Required: nuance_integration_id, botExecutionConfigurations.
- **create_integration_speech_nuance_bot_launch_validate** — Try out a single credential for a Nuance bot to know if the secret is correct. (POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate) Requires permission integrations:integration:edit. Required: nuance_integration_id, botId, executionHost, botCredentials.
- **get_single_genesys_cloud_integration_speech_nuance_bot_by_id** — Get a Nuance bot in the specified Integration. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}) Requires permission integrations:integration:view. The id is the botId. Required: id, nuance_integration_id.
- **list_all_genesys_cloud_integration_speech_nuance_bots** — Get a list of Nuance bots available in the specified Integration. If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned. (GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize. Required: nuance_integration_id.
- **get_single_genesys_cloud_integration_speech_stt_engine_by_id** — Get details about a STT engine. (GET /api/v2/integrations/speech/stt/engines/{engineId}) Requires permission integrations:integration:view. The id is the engineId. Required: id.
- **list_all_genesys_cloud_integration_speech_stt_engines** — Get a list of STT engines enabled for org. (GET /api/v2/integrations/speech/stt/engines) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_integration_speech_tts_engine_voice_by_id** — Get details about a specific voice for a TTS engine. (GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}) Requires permission integrations:integration:view. The id is the voiceId. Required: id, engine_id.
- **list_all_genesys_cloud_integration_speech_tts_engine_voices** — Get a list of voices for a TTS engine. (GET /api/v2/integrations/speech/tts/engines/{engineId}/voices) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize. Required: engine_id.
- **get_single_genesys_cloud_integration_speech_tts_engine_by_id** — Get details about a TTS engine. (GET /api/v2/integrations/speech/tts/engines/{engineId}) Requires permission integrations:integration:view. The id is the engineId. Required: id.
- **list_all_genesys_cloud_integration_speech_tts_engines** — Get a list of TTS engines enabled for org. (GET /api/v2/integrations/speech/tts/engines) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_integration_speech_tts_settings_bulk_update** — Update TTS settings for an org. (PUT /api/v2/integrations/speech/tts/settings) Requires permission integrations:integration:edit. Required: defaultEngine, languageOverrides.
- **genesys_cloud_integration_speech_tts_settings_lookup** — Get TTS settings for an org. (GET /api/v2/integrations/speech/tts/settings) Requires permission integrations:integration:view.
- **get_single_genesys_cloud_integration_type_configschema_by_id** — Get properties config schema for an integration type. (GET /api/v2/integrations/types/{typeId}/configschemas/{configType}) Requires permission integrations:integration:view. The id is the configType. Required: id, type_id.
- **get_single_genesys_cloud_integration_type_by_id** — Get integration type. (GET /api/v2/integrations/types/{typeId}) Requires permission integrations:integration:view. The id is the typeId. Required: id.
- **list_all_genesys_cloud_integration_types** — List integration types. (GET /api/v2/integrations/types) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **get_integration_unifiedcommunication_clientapp_by_id** — UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application. (GET /api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}) Requires permission integration:unifiedCommunications:view. The id is the ucIntegrationId. Required: id.
- **list_all_integration_unifiedcommunication_clientapps** — List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled. (GET /api/v2/integrations/unifiedcommunications/clientapps) Requires permission integration:unifiedCommunications:view. Pages automatically with pageNumber/pageSize.
- **integration_unifiedcommunication_thirdpartypresences_bulk_update** — Bulk integration presence ingestion. This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value. (PUT /api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences) Requires permission integration:presence:edit. Required: uc_integration_id.
- **list_all_genesys_cloud_integration_userapps** — List permitted user app integrations for the logged in user. (GET /api/v2/integrations/userapps) Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_integration** — Create an integration. (POST /api/v2/integrations) Requires permission integrations:integration:add. Required: name, integrationType.
- **delete_a_genesys_cloud_integration_by_id** — Delete integration. (DELETE /api/v2/integrations/{integrationId}) Requires permission integrations:integration:delete. The id is the integrationId. Required: id.
- **get_single_genesys_cloud_integration_by_id** — Get integration. (GET /api/v2/integrations/{integrationId}) Requires permission integrations:integration:view. The id is the integrationId. Required: id.
- **list_all_genesys_cloud_integrations** — List integrations. (GET /api/v2/integrations) Requires permission integrations:integration:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_integration_by_id** — Update an integration. (PATCH /api/v2/integrations/{integrationId}) Requires permission integrations:integration:edit. The id is the integrationId. Required: id, intendedState.
- **create_intent_assignment_customerintent_assignment** — Create customer intent assignment for external contact. (POST /api/v2/intents/assignments/externalcontacts/{externalContactId}/customerintents/{customerIntentId}/assignment) Requires permission externalContacts:customerIntentAssignments:add. Required: external_contact_id, customer_intent_id.
- **get_single_genesys_cloud_intent_assignment_externalcontact_by_id** — Get customer intent assignments for externalContactId. (GET /api/v2/intents/assignments/externalcontacts/{externalContactId}) Requires permission externalContacts:customerIntentAssignments:view. The id is the externalContactId. Required: id.
- **create_a_genesys_cloud_intent_category** — Create category. (POST /api/v2/intents/categories) Requires permission externalContacts:customerIntentTaxonomy:add. Required: name, description.
- **delete_a_genesys_cloud_intent_category_by_id** — Delete category for categoryId. (DELETE /api/v2/intents/categories/{categoryId}) Requires permission externalContacts:customerIntentTaxonomy:delete. The id is the categoryId. Required: id.
- **get_single_genesys_cloud_intent_category_by_id** — Get category for categoryId. (GET /api/v2/intents/categories/{categoryId}) Requires permission externalContacts:customerIntentTaxonomy:view. The id is the categoryId. Required: id.
- **list_all_genesys_cloud_intent_categories** — Get categories. (GET /api/v2/intents/categories) Requires permission externalContacts:customerIntentTaxonomy:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_intent_category_by_id** — Patch category for categoryId. (PATCH /api/v2/intents/categories/{categoryId}) Requires permission externalContacts:customerIntentTaxonomy:edit. The id is the categoryId. Required: id.
- **create_a_genesys_cloud_intent_customerintent_bulk_retrieve** — Get customer intents by IDs. (POST /api/v2/intents/customerintents/bulk/retrieve) Requires permission externalContacts:customerIntentTaxonomy:view. Required: ids.
- **create_intent_customerintent_sourceintent_bulk_add** — Bulk add source intents to a customer intent. (POST /api/v2/intents/customerintents/{customerIntentId}/sourceintents/bulk/add) Requires permission externalContacts:customerIntentTaxonomy:edit. Required: customer_intent_id, items.
- **create_intent_customerintent_sourceintent_bulk_remove** — Bulk remove source intents mapped to a customer intent. (POST /api/v2/intents/customerintents/{customerIntentId}/sourceintents/bulk/remove) Requires permission externalContacts:customerIntentTaxonomy:edit. Required: customer_intent_id, items.
- **list_all_genesys_cloud_intent_customerintent_sourceintents** — Get source intents mapped to a customer intent. (GET /api/v2/intents/customerintents/{customerIntentId}/sourceintents) Requires permission externalContacts:customerIntentTaxonomy:view. Pages automatically with pageNumber/pageSize. Required: customer_intent_id.
- **create_a_genesys_cloud_intent_customerintent** — Create customer intents. (POST /api/v2/intents/customerintents) Requires permission externalContacts:customerIntentTaxonomy:add. Required: name, description, expiryTime, categoryId.
- **delete_a_genesys_cloud_intent_customerintent_by_id** — Delete customer intent for customerIntentId. (DELETE /api/v2/intents/customerintents/{customerIntentId}) Requires permission externalContacts:customerIntentTaxonomy:delete. The id is the customerIntentId. Required: id.
- **get_single_genesys_cloud_intent_customerintent_by_id** — Get customer intent for customerIntentId. (GET /api/v2/intents/customerintents/{customerIntentId}) Requires permission externalContacts:customerIntentTaxonomy:view. The id is the customerIntentId. Required: id.
- **list_all_genesys_cloud_intent_customerintents** — Get customer intents. (GET /api/v2/intents/customerintents) Requires permission externalContacts:customerIntentTaxonomy:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_intent_customerintent_by_id** — Patch customer intent for customerIntentId. (PATCH /api/v2/intents/customerintents/{customerIntentId}) Requires permission externalContacts:customerIntentTaxonomy:edit. The id is the customerIntentId. Required: id.
- **list_all_genesys_cloud_intent_sourceintents** — Get all mapped source intents by type. If no type selected default is type Segment. (GET /api/v2/intents/sourceintents) Requires permission externalContacts:customerIntentTaxonomy:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_ipranges** — Get public ip address ranges for Genesys Cloud. (GET /api/v2/ipranges)
- **create_a_genesys_cloud_journey_actionmap** — Create an action map. (POST /api/v2/journey/actionmaps) Requires permission journey:actionmap:add. Required: displayName.
- **delete_a_genesys_cloud_journey_actionmap_by_id** — Delete single action map. (DELETE /api/v2/journey/actionmaps/{actionMapId}) Requires permission journey:actionmap:delete. The id is the actionMapId. Required: id.
- **get_single_genesys_cloud_journey_actionmap_by_id** — Retrieve a single action map. (GET /api/v2/journey/actionmaps/{actionMapId}) Requires permission journey:actionmap:view. The id is the actionMapId. Required: id.
- **list_all_genesys_cloud_journey_actionmaps** — Retrieve all action maps. (GET /api/v2/journey/actionmaps) Requires permission journey:actionmap:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_journey_actionmap_by_id** — Update single action map. (PATCH /api/v2/journey/actionmaps/{actionMapId}) Requires permission journey:actionmap:edit. The id is the actionMapId. Required: id, displayName, triggerWithSegments, pageUrlConditions.
- **create_a_genesys_cloud_journey_actiontemplate** — Create a single action template. (POST /api/v2/journey/actiontemplates) Requires permission journey:actiontemplate:add. Required: name, mediaType, state.
- **delete_a_genesys_cloud_journey_actiontemplate_by_id** — Delete a single action template. (DELETE /api/v2/journey/actiontemplates/{actionTemplateId}) Requires permission journey:actiontemplate:delete. The id is the actionTemplateId. Required: id.
- **get_single_genesys_cloud_journey_actiontemplate_by_id** — Retrieve a single action template. (GET /api/v2/journey/actiontemplates/{actionTemplateId}) Requires permission journey:actiontemplate:view. The id is the actionTemplateId. Required: id.
- **list_all_genesys_cloud_journey_actiontemplates** — Retrieve all action templates. (GET /api/v2/journey/actiontemplates) Requires permission journey:actiontemplate:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_journey_actiontemplate_by_id** — Update a single action template. (PATCH /api/v2/journey/actiontemplates/{actionTemplateId}) Requires permission journey:actiontemplate:edit. The id is the actionTemplateId. Required: id, name.
- **create_a_genesys_cloud_journey_externalevent_configuration_event** — Create external events. (POST /api/v2/journey/externalevents/configurations/{configurationId}/events) Requires permission journey:externalEventsEvent:add. Required: configuration_id, entities.
- **create_a_genesys_cloud_journey_externalevent_configuration** — Create an external events configuration. (POST /api/v2/journey/externalevents/configurations) Requires permission journey:externalEventsConfiguration:add. Required: name, description, divisionId, schemaId, source.
- **delete_a_genesys_cloud_journey_externalevent_configuration_by_id** — Delete an external events configuration. (DELETE /api/v2/journey/externalevents/configurations/{configId}) Requires permission journey:externalEventsConfiguration:delete. The id is the configId. Required: id.
- **get_journey_externalevent_configuration_by_id** — Get an external events configuration. (GET /api/v2/journey/externalevents/configurations/{configId}) Requires permission journey:externalEventsConfiguration:view. The id is the configId. Required: id.
- **list_all_genesys_cloud_journey_externalevent_configurations** — Get all external event configurations. (GET /api/v2/journey/externalevents/configurations) Requires permission journey:externalEventsConfiguration:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_journey_externalevent_configuration_by_id** — Update an external events configuration. (PATCH /api/v2/journey/externalevents/configurations/{configId}) Requires permission journey:externalEventsConfiguration:edit. The id is the configId. Required: id.
- **get_journey_externalevent_schema_coretype_by_id** — Get a core type from which all schemas are built. (GET /api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}) Requires permission journey:externalEventsSchema:view. The id is the coreTypeName. Required: id.
- **list_all_genesys_cloud_journey_externalevent_schema_coretypes** — Get the list of core types enabled for a specific namespace. (GET /api/v2/journey/externalevents/schemas/coretypes) Requires permission journey:externalEventsSchema:view.
- **genesys_cloud_journey_externalevent_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/journey/externalevents/schemas/limits) Requires permission journey:externalEventsSchema:view.
- **get_journey_externalevent_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}) Requires permission journey:externalEventsSchema:view. The id is the versionId. Required: id, schema_id.
- **list_all_genesys_cloud_journey_externalevent_schema_versions** — Get all versions of a External Events schema. (GET /api/v2/journey/externalevents/schemas/{schemaId}/versions) Requires permission journey:externalEventsSchema:view. Required: schema_id.
- **create_a_genesys_cloud_journey_externalevent_schema** — Create a schema. (POST /api/v2/journey/externalevents/schemas) Requires permission journey:externalEventsSchema:add. Required: title, properties.
- **delete_a_genesys_cloud_journey_externalevent_schema_by_id** — Delete a schema. (DELETE /api/v2/journey/externalevents/schemas/{schemaId}) Requires permission journey:externalEventsSchema:delete. The id is the schemaId. Required: id.
- **get_single_genesys_cloud_journey_externalevent_schema_by_id** — Get a schema. (GET /api/v2/journey/externalevents/schemas/{schemaId}) Requires permission journey:externalEventsSchema:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_journey_externalevent_schemas** — Get a list of schemas. (GET /api/v2/journey/externalevents/schemas) Requires permission journey:externalEventsSchema:view.
- **update_a_genesys_cloud_journey_externalevent_schema_by_id** — Update a schema. (PUT /api/v2/journey/externalevents/schemas/{schemaId}) Requires permission journey:externalEventsSchema:edit. The id is the schemaId. Required: id, version, enabled, jsonSchema.
- **genesys_cloud_journey_flow_paths_search** — Query for flow paths. (POST /api/v2/journey/flows/paths/query) Requires permission journey:flowpaths:view. Required: category, flows.
- **create_a_genesys_cloud_journey_segment** — Create a segment. (POST /api/v2/journey/segments) Requires permission journey:segment:add. Required: displayName.
- **delete_a_genesys_cloud_journey_segment_by_id** — Delete a segment. (DELETE /api/v2/journey/segments/{segmentId}) Requires permission journey:segment:delete. The id is the segmentId. Required: id.
- **get_single_genesys_cloud_journey_segment_by_id** — Retrieve a single segment. (GET /api/v2/journey/segments/{segmentId}) Requires permission journey:segment:view. The id is the segmentId. Required: id.
- **list_all_genesys_cloud_journey_segments** — Retrieve all segments. (GET /api/v2/journey/segments) Requires permission journey:segment:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_journey_segment_by_id** — Update a segment. (PATCH /api/v2/journey/segments/{segmentId}) Requires permission journey:segment:edit. The id is the segmentId. Required: id.
- **list_all_genesys_cloud_journey_session_events** — Retrieve all events for a given session. (GET /api/v2/journey/sessions/{sessionId}/events) Requires permission journey:event:view. Pages automatically: pass the returned next_cursor to get the next page. Required: session_id.
- **get_single_genesys_cloud_journey_session_by_id** — Retrieve a single session. (GET /api/v2/journey/sessions/{sessionId}) Requires any of permissions journey:session:view, externalContacts:session:view. The id is the sessionId. Required: id.
- **genesys_cloud_journey_view_data_details_lookup** — Get details about the data available for journey queries including oldest and newest event dates. (GET /api/v2/journey/views/data/details) Requires permission journey:dataDetails:view.
- **create_a_genesys_cloud_journey_view_encoding_validate** — Validate whether an encoding exist for a label/value combination. True indicates a valid encoding. (POST /api/v2/journey/views/encodings/validate) Requires permission journey:viewsEncodings:view.
- **genesys_cloud_journey_view_eventdefinition_activate_bulk_update** — Activate external event for journey views. (PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate) Requires permission journey:externalEvents:activate. Required: event_definition_id, displayName, rank.
- **list_all_genesys_cloud_journey_view_eventdefinition_external** — Get external events for journey views. (GET /api/v2/journey/views/eventdefinitions/external) Requires permission journey:externalEvents:view.
- **list_all_journey_view_eventdefinition_external_changes** — Get changes in external event definitions. (GET /api/v2/journey/views/eventdefinitions/external/changes) Requires permission journey:externalEvents:view.
- **get_single_genesys_cloud_journey_view_eventdefinition_by_id** — Get an Event Definition. (GET /api/v2/journey/views/eventdefinitions/{eventDefinitionId}) Requires permission journey:eventDefinition:view. The id is the eventDefinitionId. Required: id.
- **list_all_genesys_cloud_journey_view_eventdefinitions** — Get a list of Event Definitions. (GET /api/v2/journey/views/eventdefinitions) Requires permission journey:eventDefinition:view.
- **update_a_genesys_cloud_journey_view_eventdefinition_by_id** — Update external event for journey views. (PUT /api/v2/journey/views/eventdefinitions/{eventDefinitionId}) Requires permission journey:externalEvents:edit. The id is the eventDefinitionId. Required: id, displayName, rank.
- **list_all_genesys_cloud_journey_view_job_me** — Get my jobs. (GET /api/v2/journey/views/jobs/me) Requires permission journey:viewsJobs:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_journey_view_jobs** — Get the jobs for an organization. (GET /api/v2/journey/views/jobs) Requires permission journey:viewsJobs:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_journey_view_schedules_bulk_delete** — Delete the Schedule of a JourneyView. (DELETE /api/v2/journey/views/{viewId}/schedules) Requires permission journey:viewsSchedule:delete. Required: view_id.
- **genesys_cloud_journey_view_schedules_bulk_update** — Update the Schedule for a JourneyView. (PUT /api/v2/journey/views/{viewId}/schedules) Requires permission journey:viewsSchedule:edit. Required: view_id, frequency.
- **create_a_genesys_cloud_journey_view_schedule** — Add a new Schedule to a JourneyView. (POST /api/v2/journey/views/{viewId}/schedules) Requires permission journey:viewsSchedule:add. Required: view_id, frequency.
- **list_all_genesys_cloud_journey_view_schedules** — Get the journey schedules for an organization. (GET /api/v2/journey/views/schedules) Requires permission journey:viewsSchedule:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_journey_view_schedules_lookup** — Get the Schedule for a JourneyView. (GET /api/v2/journey/views/{viewId}/schedules) Requires permission journey:viewsSchedule:view. Required: view_id.
- **get_journey_view_version_chart_version_by_id** — Get a Chart by ID and version. (GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}) Requires permission journey:views:view. The id is the chartVersion. Required: id, view_id, journey_view_version, chart_id.
- **get_single_genesys_cloud_journey_view_version_chart_by_id** — Get a Chart by ID. returns the latest version. (GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}) Requires permission journey:views:view. The id is the chartId. Required: id, view_id, journey_view_version.
- **genesys_cloud_journey_view_version_job_latest_lookup** — Get the latest job of a journey view version. (GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest) Requires permission journey:viewsJobs:view. Required: view_id, journey_version_id.
- **get_journey_view_version_job_result_chart_by_id** — Get the chart result associated with a journey view job. (GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}) Requires permission journey:viewsResults:view. The id is the chartId. Required: id, view_id, journey_version_id, job_id.
- **genesys_cloud_journey_view_version_job_results_lookup** — Get the result of a job for a journey view version. (GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results) Requires permission journey:viewsResults:view. Required: view_id, journey_view_version, job_id.
- **create_a_genesys_cloud_journey_view_version_job** — Submit a job request for a journey view version. (POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs) Requires permission journey:viewsJobs:add. Required: view_id, journey_version_id.
- **get_single_genesys_cloud_journey_view_version_job_by_id** — Get the job for a journey view version. (GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}) Requires permission journey:viewsJobs:view. The id is the jobId. Required: id, view_id, journey_version_id.
- **update_a_genesys_cloud_journey_view_version_job_by_id** — Update the job for a journey view version. Only the status can be changed and only to Cancelled. (PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}) Requires permission journey:viewsJobs:edit. The id is the jobId. Required: id, view_id, journey_version_id, status, journeyView.
- **create_a_genesys_cloud_journey_view_version** — Update a Journey View by ID. creates a new version. (POST /api/v2/journey/views/{viewId}/versions) Requires permission journey:views:edit. Required: view_id, elements.
- **get_single_genesys_cloud_journey_view_version_by_id** — Get a Journey View by ID and version. (GET /api/v2/journey/views/{viewId}/versions/{versionId}) Requires permission journey:views:view. The id is the versionId. Required: id, view_id.
- **update_a_genesys_cloud_journey_view_version_by_id** — Update a Journey View by ID and version. does not create a new version. (PUT /api/v2/journey/views/{viewId}/versions/{versionId}) Requires permission journey:views:edit. The id is the versionId. Required: id, view_id, elements.
- **create_a_genesys_cloud_journey_view** — Create a new Journey View. (POST /api/v2/journey/views) Requires permission journey:views:add. Required: elements.
- **delete_a_genesys_cloud_journey_view_by_id** — Delete a Journey View by ID. deletes all versions. (DELETE /api/v2/journey/views/{viewId}) Requires permission journey:views:delete. The id is the viewId. Required: id.
- **get_single_genesys_cloud_journey_view_by_id** — Get a Journey View by ID. returns the latest version. (GET /api/v2/journey/views/{viewId}) Requires permission journey:views:view. The id is the viewId. Required: id.
- **list_all_genesys_cloud_journey_views** — Get a list of Journey Views. (GET /api/v2/journey/views) Requires permission journey:views:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_knowledge_search** — Get Knowledge Search. (POST /api/v2/knowledge/search) Requires permission knowledge:knowledgeSetting:search. Required: query, knowledgeSettingId.
- **list_all_genesys_cloud_knowledge_connection_options** — Get connection options. (GET /api/v2/knowledge/connections/{connectionId}/options) Requires permission knowledge:connectionOptions:view. Pages automatically: pass the returned next_cursor to get the next page. Required: connection_id.
- **create_a_genesys_cloud_knowledge_connection** — Create new connection. (POST /api/v2/knowledge/connections) Requires permission knowledge:connection:add. Required: integrationId, redirectUrl.
- **delete_a_genesys_cloud_knowledge_connection_by_id** — Delete connection. (DELETE /api/v2/knowledge/connections/{connectionId}) Requires permission knowledge:connection:delete. The id is the connectionId. Required: id.
- **get_single_genesys_cloud_knowledge_connection_by_id** — Get connection. (GET /api/v2/knowledge/connections/{connectionId}) Requires permission knowledge:connection:view. The id is the connectionId. Required: id.
- **list_all_genesys_cloud_knowledge_connections** — Get connections. (GET /api/v2/knowledge/connections) Requires permission knowledge:connection:view.
- **update_a_genesys_cloud_knowledge_connection_by_id** — Update connection. (PATCH /api/v2/knowledge/connections/{connectionId}) Requires permission knowledge:connection:edit. The id is the connectionId. Required: id, code.
- **create_a_genesys_cloud_knowledge_documentupload** — Creates a presigned URL for uploading a knowledge import file with a set of documents. (POST /api/v2/knowledge/documentuploads) Requires permission knowledge:document:upload.
- **list_all_genesys_cloud_knowledge_integration_options** — Get sync options available for a knowledge-connect integration. (GET /api/v2/knowledge/integrations/{integrationId}/options) Requires permission knowledge:integrationOptions:view. Required: integration_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_category** — Create new category. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories) Requires permission knowledge:category:add. Required: knowledge_base_id, name.
- **delete_a_genesys_cloud_knowledge_knowledgebase_category_by_id** — Delete category. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}) Requires permission knowledge:category:delete. The id is the categoryId. Required: id, knowledge_base_id.
- **get_single_genesys_cloud_knowledge_knowledgebase_category_by_id** — Get category. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}) Requires permission knowledge:category:view. The id is the categoryId. Required: id, knowledge_base_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_categories** — Get categories. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories) Requires permission knowledge:category:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id.
- **update_a_genesys_cloud_knowledge_knowledgebase_category_by_id** — Update category. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}) Requires permission knowledge:category:edit. The id is the categoryId. Required: id, knowledge_base_id.
- **update_knowledge_knowledgebase_chunk_search_by_id** — Register chunk search result. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search/{searchId}) Requires permission knowledge:knowledgebase:search. The id is the searchId. Required: id, knowledge_base_id, answered.
- **genesys_cloud_knowledge_knowledgebase_chunks_search** — Search for chunks in a knowledge base. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search) Requires permission knowledge:knowledgebase:search. Required: knowledge_base_id, query.
- **create_a_genesys_cloud_knowledge_knowledgebase_document_answer** — Answer documents. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers) Requires permissions knowledge:document:view, knowledge:documentAnswer:view. Required: knowledge_base_id, variationIds.
- **create_knowledge_knowledgebase_document_bulk_remove** — Bulk remove documents. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove) Requires permission knowledge:document:delete. Required: knowledge_base_id, entities.
- **create_knowledge_knowledgebase_document_bulk_update** — Bulk update documents. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update) Requires permission knowledge:document:edit. Required: knowledge_base_id, entities.
- **create_a_genesys_cloud_knowledge_knowledgebase_document_copy** — Indicate that the document was copied by the user. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies) Requires permission knowledge:documentCopy:add. Required: knowledge_base_id, document_id, documentVariationId, documentVersionId, application.
- **create_a_genesys_cloud_knowledge_knowledgebase_document_feedback** — Give feedback on a document. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback) Requires permission knowledge:feedback:create. Required: knowledge_base_id, document_id, documentVariation, rating, document, application.
- **get_knowledge_knowledgebase_document_feedback_by_id** — Get a single feedback record given on a document. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}) Requires permission knowledge:feedback:view. The id is the feedbackId. Required: id, knowledge_base_id, document_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_document_feedback** — Get a list of feedback records given on documents in a knowledge base. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback) Requires permission knowledge:feedback:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id.
- **update_knowledge_knowledgebase_document_feedback_by_id** — Update feedback on a document. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}) Requires permission knowledge:feedback:edit. The id is the feedbackId. Required: id, knowledge_base_id, document_id, rating.
- **list_all_knowledge_knowledgebase_document_feedback_by_document** — Get a list of feedback records given on a document. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback) Requires permission knowledge:feedback:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id, document_id.
- **create_knowledge_knowledgebase_document_presentation** — Indicate that documents were presented to the user. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations) Requires permission knowledge:documentPresentation:add. Required: knowledge_base_id, documents, application.
- **update_knowledge_knowledgebase_document_search_by_id** — Update search result. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}) Requires permission knowledge:search:edit. The id is the searchId. Required: id, knowledge_base_id, answered.
- **create_knowledge_knowledgebase_document_search_suggestion** — Query the knowledge documents to provide suggestions for auto completion. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions) Requires permission knowledge:knowledgebase:search. Required: knowledge_base_id, query.
- **create_knowledge_knowledgebase_document_variation** — Create a variation for a document. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations) Requires any of permissions knowledge:document:add, knowledge:document:edit. Required: knowledge_base_id, document_id, contexts.
- **delete_knowledge_knowledgebase_document_variation_by_id** — Delete a variation for a document. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}) Requires any of permissions knowledge:document:delete, knowledge:document:edit. The id is the documentVariationId. Required: id, document_id, knowledge_base_id.
- **get_knowledge_knowledgebase_document_variation_by_id** — Get a variation for a document. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}) Requires permission knowledge:document:view. The id is the documentVariationId. Required: id, document_id, knowledge_base_id.
- **list_all_knowledge_knowledgebase_document_variations** — Get variations for a document. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations) Requires permission knowledge:document:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id, document_id.
- **update_knowledge_knowledgebase_document_variation_by_id** — Update a variation for a document. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}) Requires permission knowledge:document:edit. The id is the documentVariationId. Required: id, document_id, knowledge_base_id.
- **create_knowledge_knowledgebase_document_version_bulk_add** — Bulk add document versions. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add) Requires permission knowledge:documentVersion:add. Required: knowledge_base_id, entities.
- **get_knowledge_knowledgebase_document_version_variation_by_id** — Get variation for the given document version. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}) Requires permission knowledge:documentVersion:view. The id is the variationId. Required: id, knowledge_base_id, document_id, version_id.
- **list_all_knowledge_knowledgebase_document_version_variations** — Get variations for the given document version. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations) Requires permission knowledge:documentVersion:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id, document_id, version_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_document_version** — Creates or restores a document version. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions) Requires permission knowledge:documentVersion:add. Required: knowledge_base_id, document_id, restoreFromVersionId.
- **get_knowledge_knowledgebase_document_version_by_id** — Get document version. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}) Requires permission knowledge:documentVersion:view. The id is the versionId. Required: id, knowledge_base_id, document_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_document_versions** — Get document versions. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions) Requires permission knowledge:documentVersion:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id, document_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_document_view** — Create view for a document. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views) Requires permission knowledge:documentView:add. Required: knowledge_base_id, document_id, documentVariationId, documentVersionId, application.
- **create_a_genesys_cloud_knowledge_knowledgebase_document** — Create document. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents) Requires permission knowledge:document:add. Required: knowledge_base_id, title.
- **delete_a_genesys_cloud_knowledge_knowledgebase_document_by_id** — Delete document. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}) Requires permission knowledge:document:delete. The id is the documentId. Required: id, knowledge_base_id.
- **get_single_genesys_cloud_knowledge_knowledgebase_document_by_id** — Get document. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}) Requires permission knowledge:document:view. The id is the documentId. Required: id, knowledge_base_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_documents** — Get documents. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents) Requires permission knowledge:document:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id.
- **genesys_cloud_knowledge_knowledgebase_documents_search** — Query for knowledge documents. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query) Requires permission knowledge:document:view. Required: knowledge_base_id, filter.
- **update_a_genesys_cloud_knowledge_knowledgebase_document_by_id** — Update document. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}) Requires permission knowledge:document:edit. The id is the documentId. Required: id, knowledge_base_id.
- **knowledge_knowledgebase_documents_by_knowledge_base_search** — Search the documents in a knowledge base. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search) Requires permission knowledge:knowledgebase:search. Required: knowledge_base_id, query.
- **create_a_genesys_cloud_knowledge_knowledgebase_export_job** — Create export job. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs) Requires permission knowledge:exportJob:add. Required: knowledge_base_id, exportFilter, fileType.
- **delete_a_genesys_cloud_knowledge_knowledgebase_export_job_by_id** — Delete export job. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}) Requires permission knowledge:exportJob:delete. The id is the exportJobId. Required: id, knowledge_base_id.
- **get_knowledge_knowledgebase_export_job_by_id** — Get export job report. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}) Requires permission knowledge:exportJob:view. The id is the exportJobId. Required: id, knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_import_job** — Create import job. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs) Requires permission knowledge:importJob:add. Required: knowledge_base_id, uploadKey, fileType.
- **delete_a_genesys_cloud_knowledge_knowledgebase_import_job_by_id** — Delete import job. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}) Requires permission knowledge:importJob:delete. The id is the importJobId. Required: id, knowledge_base_id.
- **get_knowledge_knowledgebase_import_job_by_id** — Get import job report. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}) Requires permission knowledge:importJob:view. The id is the importJobId. Required: id, knowledge_base_id.
- **update_a_genesys_cloud_knowledge_knowledgebase_import_job_by_id** — Start import job. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}) Requires permission knowledge:importJob:edit. The id is the importJobId. Required: id, knowledge_base_id, status.
- **create_a_genesys_cloud_knowledge_knowledgebase_label** — Create new label. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels) Requires permission knowledge:label:add. Required: knowledge_base_id, name, color.
- **delete_a_genesys_cloud_knowledge_knowledgebase_label_by_id** — Delete label. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}) Requires permission knowledge:label:delete. The id is the labelId. Required: id, knowledge_base_id.
- **get_single_genesys_cloud_knowledge_knowledgebase_label_by_id** — Get label. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}) Requires permission knowledge:label:view. The id is the labelId. Required: id, knowledge_base_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_labels** — Get labels. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels) Requires permission knowledge:label:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id.
- **update_a_genesys_cloud_knowledge_knowledgebase_label_by_id** — Update label. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}) Requires permission knowledge:label:edit. The id is the labelId. Required: id, knowledge_base_id.
- **knowledge_knowledgebase_operation_user_query_lookup** — Get ids of operation creator users and oauth clients. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query) Requires permission knowledge:importExportOperationsList:view. Required: knowledge_base_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_operations** — Get operations. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations) Requires permission knowledge:importExportOperationsList:view. Pages automatically: pass the returned next_cursor to get the next page. Required: knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_parse_job_import** — Import the parsed articles. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import) Requires permission knowledge:importJob:edit. Required: knowledge_base_id, parse_job_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_parse_job** — Create parse job. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs) Requires permission knowledge:importJob:add. Required: knowledge_base_id, uploadKey.
- **get_single_genesys_cloud_knowledge_knowledgebase_parse_job_by_id** — Get parse job report. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}) Requires permission knowledge:importJob:view. The id is the parseJobId. Required: id, knowledge_base_id.
- **update_a_genesys_cloud_knowledge_knowledgebase_parse_job_by_id** — Send update to the parse operation. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}) Requires permission knowledge:importJob:edit. The id is the parseJobId. Required: id, knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_source_salesforce** — Create Salesforce Knowledge integration source. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce) Requires permission knowledge:integrationSource:add. Required: knowledge_base_id, name.
- **delete_knowledge_knowledgebase_source_salesforce_by_id** — Delete Salesforce Knowledge integration source. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}) Requires permission knowledge:integrationSource:delete. The id is the sourceId. Required: id, knowledge_base_id.
- **get_knowledge_knowledgebase_source_salesforce_by_id** — Get Salesforce Knowledge integration source. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}) Requires permission knowledge:integrationSource:view. The id is the sourceId. Required: id, knowledge_base_id.
- **update_knowledge_knowledgebase_source_salesforce_by_id** — Update Salesforce Knowledge integration source. (PUT /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}) Requires permission knowledge:integrationSource:edit. The id is the sourceId. Required: id, knowledge_base_id, name.
- **create_knowledge_knowledgebase_source_salesforce_sync** — Start sync on Salesforce Knowledge integration source. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync) Requires permission knowledge:integrationSource:edit. Required: knowledge_base_id, source_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_source_servicenow** — Create ServiceNow Knowledge integration source. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow) Requires permission knowledge:integrationSource:add. Required: knowledge_base_id, name.
- **delete_knowledge_knowledgebase_source_servicenow_by_id** — Delete ServiceNow Knowledge integration source. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}) Requires permission knowledge:integrationSource:delete. The id is the sourceId. Required: id, knowledge_base_id.
- **get_knowledge_knowledgebase_source_servicenow_by_id** — Get ServiceNow Knowledge integration source. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}) Requires permission knowledge:integrationSource:view. The id is the sourceId. Required: id, knowledge_base_id.
- **update_knowledge_knowledgebase_source_servicenow_by_id** — Update ServiceNow Knowledge integration source. (PUT /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}) Requires permission knowledge:integrationSource:edit. The id is the sourceId. Required: id, knowledge_base_id, name.
- **create_knowledge_knowledgebase_source_servicenow_sync** — Start synchronization on ServiceNow Knowledge integration source. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync) Requires permission knowledge:integrationSource:edit. Required: knowledge_base_id, source_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_sources** — Get Knowledge integration sources. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources) Requires permission knowledge:integrationSource:view. Required: knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_synchronize_job** — Create synchronization job. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs) Requires permission knowledge:syncJob:add. Required: knowledge_base_id, uploadKey.
- **delete_knowledge_knowledgebase_synchronize_job_by_id** — Delete synchronization job. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}) Requires permission knowledge:syncJob:delete. The id is the syncJobId. Required: id, knowledge_base_id.
- **get_knowledge_knowledgebase_synchronize_job_by_id** — Get synchronization job report. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}) Requires permission knowledge:syncJob:view. The id is the syncJobId. Required: id, knowledge_base_id.
- **update_knowledge_knowledgebase_synchronize_job_by_id** — Update synchronization job. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}) Requires permission knowledge:syncJob:edit. The id is the syncJobId. Required: id, knowledge_base_id, status.
- **get_knowledge_knowledgebase_unanswered_group_phrasegroup_by_id** — Get knowledge base unanswered phrase group for a particular phraseGroupId. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}) Requires permission knowledge:groups:view. The id is the phraseGroupId. Required: id, knowledge_base_id, group_id.
- **update_knowledge_knowledgebase_unanswered_group_phrasegroup** — Update a Knowledge base unanswered phrase group. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}) Requires permissions knowledge:groups:edit, knowledge:document:edit. The id is the phraseGroupId. Required: id, knowledge_base_id, group_id, phraseAssociations.
- **get_knowledge_knowledgebase_unanswered_group_by_id** — Get knowledge base unanswered group for a particular groupId. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}) Requires permission knowledge:groups:view. The id is the groupId. Required: id, knowledge_base_id.
- **list_all_genesys_cloud_knowledge_knowledgebase_unanswered_groups** — Get knowledge base unanswered groups. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups) Requires permission knowledge:groups:view. Required: knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase_upload_url_job** — Create content upload from URL job. (POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs) Requires permission knowledge:uploadSourceUrlJob:add. Required: knowledge_base_id, uploadUrl.
- **get_knowledge_knowledgebase_upload_url_job_by_id** — Get content upload from URL job status. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}) Requires permission knowledge:uploadSourceUrlJob:view. The id is the jobId. Required: id, knowledge_base_id.
- **create_a_genesys_cloud_knowledge_knowledgebase** — Create new knowledge base. (POST /api/v2/knowledge/knowledgebases) Requires permission knowledge:knowledgebase:add. Required: name, coreLanguage.
- **delete_a_genesys_cloud_knowledge_knowledgebase_by_id** — Delete knowledge base. (DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}) Requires permission knowledge:knowledgebase:delete. The id is the knowledgeBaseId. Required: id.
- **get_single_genesys_cloud_knowledge_knowledgebase_by_id** — Get knowledge base. (GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}) Requires permission knowledge:knowledgebase:view. The id is the knowledgeBaseId. Required: id.
- **list_all_genesys_cloud_knowledge_knowledgebases** — Get knowledge bases. (GET /api/v2/knowledge/knowledgebases) Requires permission knowledge:knowledgebase:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_knowledge_knowledgebase_by_id** — Update knowledge base. (PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}) Requires permission knowledge:knowledgebase:edit. The id is the knowledgeBaseId. Required: id.
- **genesys_cloud_knowledge_search_preview** — Get Knowledge Search Preview. (POST /api/v2/knowledge/search/preview) Requires permission knowledge:knowledgeSetting:searchPreview. Required: query, sources, generationSetting.
- **create_a_genesys_cloud_knowledge_setting** — Create Knowledge setting. (POST /api/v2/knowledge/settings) Requires permission knowledge:knowledgeSetting:add. Required: name, sources.
- **delete_a_genesys_cloud_knowledge_setting_by_id** — Delete Knowledge setting. (DELETE /api/v2/knowledge/settings/{knowledgeSettingId}) Requires permission knowledge:knowledgeSetting:delete. The id is the knowledgeSettingId. Required: id.
- **get_single_genesys_cloud_knowledge_setting_by_id** — Get Knowledge setting. (GET /api/v2/knowledge/settings/{knowledgeSettingId}) Requires permission knowledge:knowledgeSetting:view. The id is the knowledgeSettingId. Required: id.
- **list_all_genesys_cloud_knowledge_settings** — Get Knowledge settings. (GET /api/v2/knowledge/settings) Requires permission knowledge:knowledgeSetting:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_knowledge_setting_by_id** — Update Knowledge setting. (PATCH /api/v2/knowledge/settings/{knowledgeSettingId}) Requires permission knowledge:knowledgeSetting:edit. The id is the knowledgeSettingId. Required: id.
- **create_a_genesys_cloud_knowledge_source_file_count** — Get per-source file counts for the selected tag filter. (POST /api/v2/knowledge/sources/files/counts) Requires permission knowledge:sourceFileCount:view. Required: sourceIds.
- **create_a_genesys_cloud_knowledge_source_synchronization_deletion** — Mark a previously synced file for deletion in the synchronization. (POST /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions) Requires permission knowledge:synchronization:deleteFile. Required: source_id, synchronization_id.
- **delete_knowledge_source_synchronization_deletion_by_id** — Remove a deletion entry associated with the synchronization. (DELETE /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId}) Requires permission knowledge:synchronizationFileDeletion:delete. The id is the fileId. Required: id, source_id, synchronization_id.
- **get_knowledge_source_synchronization_deletion_by_id** — Get a deletion entry associated with the synchronization. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId}) Requires permission knowledge:synchronizationFileDeletion:view. The id is the fileId. Required: id, source_id, synchronization_id.
- **list_all_knowledge_source_synchronization_deletions** — Get deletion entries associated with the synchronization. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions) Requires permission knowledge:synchronizationFileDeletion:view. Pages automatically: pass the returned next_cursor to get the next page. Required: source_id, synchronization_id.
- **create_a_genesys_cloud_knowledge_source_synchronization_upload** — Create presigned URL for uploading a file in the synchronization. (POST /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads) Requires permission knowledge:synchronization:upload. Required: source_id, synchronization_id, fileName.
- **delete_knowledge_source_synchronization_upload_by_id** — Remove a file upload entry associated with the synchronization. (DELETE /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId}) Requires permission knowledge:synchronizationFileUpload:delete. The id is the fileId. Required: id, source_id, synchronization_id.
- **get_knowledge_source_synchronization_upload_by_id** — Get a file upload entry associated with the synchronization. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId}) Requires permission knowledge:synchronizationFileUpload:view. The id is the fileId. Required: id, source_id, synchronization_id.
- **list_all_genesys_cloud_knowledge_source_synchronization_uploads** — Get file upload entries associated with the synchronization. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads) Requires permission knowledge:synchronizationFileUpload:view. Pages automatically: pass the returned next_cursor to get the next page. Required: source_id, synchronization_id.
- **create_a_genesys_cloud_knowledge_source_synchronization** — Start a manual synchronization from a source. (POST /api/v2/knowledge/sources/{sourceId}/synchronizations) Requires permission knowledge:synchronization:add. Required: source_id.
- **get_single_genesys_cloud_knowledge_source_synchronization_by_id** — Get a specific synchronization of a source. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}) Requires permission knowledge:synchronization:view. The id is the synchronizationId. Required: id, source_id.
- **list_all_genesys_cloud_knowledge_source_synchronizations** — Get synchronizations of all sources of the organization. (GET /api/v2/knowledge/sources/synchronizations) Requires permission knowledge:synchronization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_knowledge_source_synchronization_by_id** — Update synchronization. (PATCH /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}) Requires permission knowledge:synchronization:edit. The id is the synchronizationId. Required: id, source_id.
- **list_all_knowledge_source_synchronizations_by_source** — Get synchronizations of a source. (GET /api/v2/knowledge/sources/{sourceId}/synchronizations) Requires permission knowledge:synchronization:view. Pages automatically: pass the returned next_cursor to get the next page. Required: source_id.
- **list_all_genesys_cloud_knowledge_source_tag_grouped** — Get tags grouped by source for the organization. (GET /api/v2/knowledge/sources/tags/grouped) Requires permission knowledge:sourceTagList:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_knowledge_source_tags** — Get tags across sources for the organization. (GET /api/v2/knowledge/sources/tags) Requires permission knowledge:sourceTagList:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_knowledge_source** — Create a new source. (POST /api/v2/knowledge/sources) Requires permission knowledge:source:add. Required: name.
- **delete_a_genesys_cloud_knowledge_source_by_id** — Delete source. (DELETE /api/v2/knowledge/sources/{sourceId}) Requires permission knowledge:source:delete. The id is the sourceId. Required: id.
- **get_single_genesys_cloud_knowledge_source_by_id** — Get source. (GET /api/v2/knowledge/sources/{sourceId}) Requires permission knowledge:source:view. The id is the sourceId. Required: id.
- **list_all_genesys_cloud_knowledge_sources** — List sources. (GET /api/v2/knowledge/sources) Requires permission knowledge:source:view.
- **update_a_genesys_cloud_knowledge_source_by_id** — Update the source. (PUT /api/v2/knowledge/sources/{sourceId}) Requires permission knowledge:source:edit. The id is the sourceId. Required: id, name, triggerType.
- **genesys_cloud_language_translation_builtin_lookup** — Get the builtin translation for a language. (GET /api/v2/languages/translations/builtin) Required: language.
- **genesys_cloud_language_translation_organization_lookup** — Get effective translation for an organization by language. (GET /api/v2/languages/translations/organization) Required: language.
- **get_single_genesys_cloud_language_translation_user_by_id** — Get effective language translation for a user. (GET /api/v2/languages/translations/users/{userId}) The id is the userId. Required: id.
- **genesys_cloud_language_translations_lookup** — Get all available languages for translation. (GET /api/v2/languages/translations)
- **create_a_genesys_cloud_languageunderstanding_domain_feedback** — Create feedback for the NLU Domain Version. (POST /api/v2/languageunderstanding/domains/{domainId}/feedback) Requires any of permissions languageUnderstanding:feedback:add, dialog:bot:add. Required: domain_id, text, intents, versionId.
- **delete_languageunderstanding_domain_feedback_by_id** — Delete the feedback on the NLU Domain Version. (DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}) Requires any of permissions languageUnderstanding:feedback:delete, dialog:bot:delete. The id is the feedbackId. Required: id, domain_id.
- **get_languageunderstanding_domain_feedback_by_id** — Find a Feedback. (GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}) Requires any of permissions languageUnderstanding:feedback:view, dialog:bot:view. The id is the feedbackId. Required: id, domain_id.
- **list_all_genesys_cloud_languageunderstanding_domain_feedback** — Get all feedback in the given NLU Domain Version. (GET /api/v2/languageunderstanding/domains/{domainId}/feedback) Requires any of permissions languageUnderstanding:feedback:view, dialog:bot:view. Pages automatically: pass the returned next_cursor to get the next page. Required: domain_id.
- **create_languageunderstanding_domain_version_detect** — Detect intent, entities, etc. in the submitted text using the specified NLU domain version. (POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect) Requires any of permissions languageUnderstanding:nluDomainVersion:view, dialog:botVersion:view. Required: domain_id, domain_version_id, input.
- **genesys_cloud_languageunderstanding_domain_version_report_lookup** — Retrieved quality report for the specified NLU Domain Version. (GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report) Requires any of permissions languageUnderstanding:nluDomainVersion:view, dialog:botVersion:view. Required: domain_id, domain_version_id.
- **create_languageunderstanding_domain_version_train** — Train the draft NLU Domain Version. (POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train) Requires any of permissions languageUnderstanding:nluDomainVersion:edit, dialog:botVersion:edit. Required: domain_id, domain_version_id.
- **create_a_genesys_cloud_languageunderstanding_domain_version** — Create an NLU Domain Version. (POST /api/v2/languageunderstanding/domains/{domainId}/versions) Requires any of permissions languageUnderstanding:nluDomainVersion:add, dialog:botVersion:add. Required: domain_id, language.
- **delete_languageunderstanding_domain_version_by_id** — Delete an NLU Domain Version. (DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}) Requires any of permissions languageUnderstanding:nluDomainVersion:delete, dialog:botVersion:delete. The id is the domainVersionId. Required: id, domain_id.
- **get_languageunderstanding_domain_version_by_id** — Find an NLU Domain Version. (GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}) Requires any of permissions languageUnderstanding:nluDomainVersion:view, dialog:botVersion:view. The id is the domainVersionId. Required: id, domain_id.
- **list_all_genesys_cloud_languageunderstanding_domain_versions** — Get all NLU Domain Versions for a given Domain. (GET /api/v2/languageunderstanding/domains/{domainId}/versions) Requires any of permissions languageUnderstanding:nluDomainVersion:view, dialog:botVersion:view. Pages automatically with pageNumber/pageSize. Required: domain_id.
- **genesys_cloud_languageunderstanding_domain_versions_publish** — Publish the draft NLU Domain Version. (POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish) Requires any of permissions languageUnderstanding:nluDomainVersion:add, dialog:botVersion:add. Required: domain_id, domain_version_id.
- **update_languageunderstanding_domain_version_by_id** — Update an NLU Domain Version. (PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}) Requires any of permissions languageUnderstanding:nluDomainVersion:edit, dialog:botVersion:edit. The id is the domainVersionId. Required: id, domain_id, language.
- **create_a_genesys_cloud_languageunderstanding_domain** — Create an NLU Domain. (POST /api/v2/languageunderstanding/domains) Requires any of permissions languageUnderstanding:nluDomain:add, dialog:bot:add. Required: name.
- **delete_a_genesys_cloud_languageunderstanding_domain_by_id** — Delete an NLU Domain. (DELETE /api/v2/languageunderstanding/domains/{domainId}) Requires any of permissions languageUnderstanding:nluDomain:delete, dialog:bot:delete. The id is the domainId. Required: id.
- **get_single_genesys_cloud_languageunderstanding_domain_by_id** — Find an NLU Domain. (GET /api/v2/languageunderstanding/domains/{domainId}) Requires any of permissions languageUnderstanding:nluDomain:view, dialog:bot:view. The id is the domainId. Required: id.
- **list_all_genesys_cloud_languageunderstanding_domains** — Get all NLU Domains. (GET /api/v2/languageunderstanding/domains) Requires any of permissions languageUnderstanding:nluDomain:view, dialog:bot:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_languageunderstanding_domain_by_id** — Update an NLU Domain. (PATCH /api/v2/languageunderstanding/domains/{domainId}) Requires any of permissions languageUnderstanding:nluDomain:edit, dialog:bot:edit. The id is the domainId. Required: id.
- **create_a_genesys_cloud_languageunderstanding_ignorephrase_remove** — Delete ignored phrases. (POST /api/v2/languageunderstanding/ignorephrases/{languageCode}/remove) Requires permission languageUnderstanding:ignoredPhrase:delete. Required: language_code, entities.
- **create_a_genesys_cloud_languageunderstanding_ignorephrase** — Add phrases to the ignored phrases list. (POST /api/v2/languageunderstanding/ignorephrases/{languageCode}) Requires permission languageUnderstanding:ignoredPhrase:add. Required: language_code, phrases.
- **get_languageunderstanding_ignorephrase_by_id** — Get list of all ignored phrases of the specified language code. (GET /api/v2/languageunderstanding/ignorephrases/{languageCode}) Requires permission languageUnderstanding:ignoredPhrase:view. The id is the languageCode. Required: id.
- **create_a_genesys_cloud_languageunderstanding_ignoretopic_remove** — Delete ignored topics. (POST /api/v2/languageunderstanding/ignoretopics/{languageCode}/remove) Requires permission languageUnderstanding:ignoredTopic:delete. Required: language_code, entities.
- **create_a_genesys_cloud_languageunderstanding_ignoretopic** — Add topics to the ignored topics list. (POST /api/v2/languageunderstanding/ignoretopics/{languageCode}) Requires permission languageUnderstanding:ignoredTopic:add. Required: language_code, topics.
- **get_single_genesys_cloud_languageunderstanding_ignoretopic_by_id** — Get list of all ignored topics of the specified language code. (GET /api/v2/languageunderstanding/ignoretopics/{languageCode}) Requires permission languageUnderstanding:ignoredTopic:view. The id is the languageCode. Required: id.
- **create_a_genesys_cloud_languageunderstanding_miner_draft** — Create a new draft resource. (POST /api/v2/languageunderstanding/miners/{minerId}/drafts) Requires permission languageUnderstanding:draft:add. Required: miner_id, name.
- **delete_a_genesys_cloud_languageunderstanding_miner_draft_by_id** — Delete a draft. (DELETE /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}) Requires permission languageUnderstanding:draft:delete. The id is the draftId. Required: id, miner_id.
- **get_single_genesys_cloud_languageunderstanding_miner_draft_by_id** — Get information about a draft. (GET /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}) Requires permission languageUnderstanding:draft:view. The id is the draftId. Required: id, miner_id.
- **list_all_genesys_cloud_languageunderstanding_miner_drafts** — Retrieve the list of drafts created. (GET /api/v2/languageunderstanding/miners/{minerId}/drafts) Requires permission languageUnderstanding:draft:view. Required: miner_id.
- **update_a_genesys_cloud_languageunderstanding_miner_draft_by_id** — Save information for the draft. Either topic draft or intent draft should be sent. (PATCH /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}) Requires permission languageUnderstanding:draft:edit. The id is the draftId. Required: id, miner_id.
- **get_languageunderstanding_miner_intent_by_id** — Get information about a mined intent. (GET /api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}) Requires permission languageUnderstanding:minerIntent:view. The id is the intentId. Required: id, miner_id.
- **list_all_genesys_cloud_languageunderstanding_miner_intents** — Retrieve a list of mined intents. (GET /api/v2/languageunderstanding/miners/{minerId}/intents) Requires permission languageUnderstanding:minerIntent:view. Required: miner_id.
- **get_languageunderstanding_miner_topic_phrase_by_id** — Retrieves utterances related to a phrase in a topic. (GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}) Requires permission languageUnderstanding:miner:view. The id is the phraseId. Required: id, miner_id, topic_id.
- **get_single_genesys_cloud_languageunderstanding_miner_topic_by_id** — Retrieves details of a particular topic. (GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}) Requires permission languageUnderstanding:miner:view. The id is the topicId. Required: id, miner_id.
- **list_all_genesys_cloud_languageunderstanding_miner_topics** — Retrieve a list of mined topics. (GET /api/v2/languageunderstanding/miners/{minerId}/topics) Requires permission languageUnderstanding:miner:view. Required: miner_id.
- **create_a_genesys_cloud_languageunderstanding_miner_upload** — Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner. (POST /api/v2/languageunderstanding/miners/{minerId}/uploads) Requires permission languageUnderstanding:miner:upload. Required: miner_id.
- **create_a_genesys_cloud_languageunderstanding_miner** — Create a unique miner. (POST /api/v2/languageunderstanding/miners) Requires permission languageUnderstanding:miner:add. Required: name.
- **delete_a_genesys_cloud_languageunderstanding_miner_by_id** — Delete a miner. (DELETE /api/v2/languageunderstanding/miners/{minerId}) Requires permission languageUnderstanding:miner:delete. The id is the minerId. Required: id.
- **genesys_cloud_languageunderstanding_miners_execute** — Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. (POST /api/v2/languageunderstanding/miners/{minerId}/execute) Requires permission languageUnderstanding:miner:execute. Required: miner_id.
- **get_single_genesys_cloud_languageunderstanding_miner_by_id** — Get information about a miner. (GET /api/v2/languageunderstanding/miners/{minerId}) Requires permission languageUnderstanding:miner:view. The id is the minerId. Required: id.
- **list_all_genesys_cloud_languageunderstanding_miners** — Retrieve the list of miners created. (GET /api/v2/languageunderstanding/miners) Requires permission languageUnderstanding:miner:view.
- **genesys_cloud_languageunderstanding_settings_lookup** — Get Organization Configuration. (GET /api/v2/languageunderstanding/settings) Requires permission languageUnderstanding:settings:view.
- **create_a_genesys_cloud_learning_assessment_scoring** — Score learning assessment for preview. (POST /api/v2/learning/assessments/scoring) Requires any of permissions learning:module:view, learning:module:add, learning:module:edit. Required: assessmentForm, answers.
- **genesys_cloud_learning_assignment_aggregates_search** — Retrieve aggregated assignment data. (POST /api/v2/learning/assignments/aggregates/query) Requires permission learning:assignment:view. Required: interval, filter.
- **create_a_genesys_cloud_learning_assignment_bulkadd** — Add multiple learning assignments. (POST /api/v2/learning/assignments/bulkadd) Requires permission learning:assignment:add.
- **create_a_genesys_cloud_learning_assignment_bulkremove** — Remove multiple Learning Assignments. (POST /api/v2/learning/assignments/bulkremove) Requires permission learning:assignment:delete.
- **list_all_genesys_cloud_learning_assignment_me** — List of Learning Assignments assigned to current user. (GET /api/v2/learning/assignments/me) Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_learning_assignment_reassign** — Reassign Learning Assignment. This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module. (POST /api/v2/learning/assignments/{assignmentId}/reassign) Requires permission learning:assignment:add. Required: assignment_id.
- **genesys_cloud_learning_assignment_reschedule_bulk_partial_update** — Reschedule Learning Assignment. (PATCH /api/v2/learning/assignments/{assignmentId}/reschedule) Requires permission learning:assignment:reschedule. Required: assignment_id, dateRecommendedForCompletion.
- **get_single_genesys_cloud_learning_assignment_step_by_id** — Get Learning Assignment Step. Permission not required if you are the assigned user of the learning assignment. (GET /api/v2/learning/assignments/{assignmentId}/steps/{stepId}) Requires permission learning:assignment:viewOwn. The id is the stepId. Required: id, assignment_id.
- **update_a_genesys_cloud_learning_assignment_step_by_id** — Update Learning Assignment Step. Permission not required if you are the assigned user of the learning assignment. (PATCH /api/v2/learning/assignments/{assignmentId}/steps/{stepId}) Requires permission learning:assignment:editOwn. The id is the stepId. Required: id, assignment_id.
- **create_a_genesys_cloud_learning_assignment** — Create Learning Assignment. (POST /api/v2/learning/assignments) Requires permission learning:assignment:add. Required: moduleId, userId.
- **delete_a_genesys_cloud_learning_assignment_by_id** — Delete a learning assignment. (DELETE /api/v2/learning/assignments/{assignmentId}) Requires permission learning:assignment:delete. The id is the assignmentId. Required: id.
- **get_single_genesys_cloud_learning_assignment_by_id** — Get Learning Assignment. Permission not required if you are the assigned user of the learning assignment. (GET /api/v2/learning/assignments/{assignmentId}) Requires permission learning:assignment:view. The id is the assignmentId. Required: id.
- **list_all_genesys_cloud_learning_assignments** — List of Learning module Assignments. Either moduleId or user value is required. (GET /api/v2/learning/assignments) Requires permission learning:assignment:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_learning_assignments_reset** — Reset Learning Assignment. This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment. (POST /api/v2/learning/assignments/{assignmentId}/reset) Requires permission learning:assignment:reset. Required: assignment_id.
- **update_a_genesys_cloud_learning_assignment_by_id** — Update Learning Assignment. (PATCH /api/v2/learning/assignments/{assignmentId}) The id is the assignmentId. Required: id.
- **list_all_genesys_cloud_learning_module_assignments** — Get all learning modules of an organization including assignments for a specific user. (GET /api/v2/learning/modules/assignments) Requires permissions learning:module:view, learning:assignment:view. Pages automatically with pageNumber/pageSize. Required: userIds.
- **get_single_genesys_cloud_learning_module_coverart_by_id** — Get a specific Learning Module cover art using ID. (GET /api/v2/learning/modules/coverart/{coverArtId}) Requires permission learning:coverart:view. The id is the coverArtId. Required: id.
- **create_a_genesys_cloud_learning_module_job** — Starts a specified operation on learning module. This will initiate operation specified in the request body for a learning module. (POST /api/v2/learning/modules/{moduleId}/jobs) Requires permission learning:module:add. Required: module_id, action.
- **get_single_genesys_cloud_learning_module_job_by_id** — Get a specific Learning Module job status. (GET /api/v2/learning/modules/{moduleId}/jobs/{jobId}) Requires permission learning:module:view. The id is the jobId. Required: id, module_id.
- **genesys_cloud_learning_module_preview_bulk_update** — Update a learning module preview. This will update a learning module preview. (PUT /api/v2/learning/modules/{moduleId}/preview) Requires permission learning:module:preview. Required: module_id.
- **genesys_cloud_learning_module_preview_lookup** — Get a learning module preview. (GET /api/v2/learning/modules/{moduleId}/preview) Requires permission learning:module:preview. Required: module_id.
- **genesys_cloud_learning_module_rule_bulk_update** — Update a learning module rule. This will update a learning module rule with the specified fields. (PUT /api/v2/learning/modules/{moduleId}/rule) Requires permission learning:rule:edit. Required: module_id, isActive, parts.
- **genesys_cloud_learning_module_rule_lookup** — Get a learning module rule. (GET /api/v2/learning/modules/{moduleId}/rule) Requires permission learning:rule:view. Required: module_id.
- **learning_module_user_assignments_bulk_partial_update** — Update an external assignment for a specific user. (PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments) Requires permission learning:externalAssignment:edit. Required: module_id, user_id.
- **get_single_genesys_cloud_learning_module_version_by_id** — Get specific version of a published module. (GET /api/v2/learning/modules/{moduleId}/versions/{versionId}) Requires permission learning:module:view. The id is the versionId. Required: id, module_id.
- **create_a_genesys_cloud_learning_module** — Create a new learning module. This will create a new unpublished learning module with the specified fields. (POST /api/v2/learning/modules) Requires permission learning:module:add. Required: name, completionTimeInDays.
- **delete_a_genesys_cloud_learning_module_by_id** — Delete a learning module. This will delete a learning module if it is unpublished or it will delete a published and archived learning module. (DELETE /api/v2/learning/modules/{moduleId}) Requires permission learning:module:delete. The id is the moduleId. Required: id.
- **get_single_genesys_cloud_learning_module_by_id** — Get a learning module. (GET /api/v2/learning/modules/{moduleId}) Requires permission learning:module:view. The id is the moduleId. Required: id.
- **list_all_genesys_cloud_learning_modules** — Get all learning modules of an organization. (GET /api/v2/learning/modules) Requires permission learning:module:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_learning_modules_publish** — Publish a Learning module. (POST /api/v2/learning/modules/{moduleId}/publish) Requires permission learning:module:publish. Required: module_id.
- **update_a_genesys_cloud_learning_module_by_id** — Update a learning module. This will update the name, description, completion time in days and inform steps for a learning module. (PUT /api/v2/learning/modules/{moduleId}) Requires permission learning:module:edit. The id is the moduleId. Required: id, name, completionTimeInDays.
- **genesys_cloud_learning_rules_search** — Get users for learning module rule. This will get the users who matches the given rule. (POST /api/v2/learning/rules/query) Requires permission learning:rule:view. Required: pageSize, pageNumber, rule.
- **create_a_genesys_cloud_learning_scheduleslot_job** — Start job to retrieve slots where a learning activity can be scheduled. (POST /api/v2/learning/scheduleslots/jobs) Requires permission learning:scheduleSlotJob:add. Required: userIds, lengthInMinutes, activityCodeId, intervals, slotsType.
- **get_single_genesys_cloud_learning_scheduleslot_job_by_id** — Retrieve the status of the job for the slots where a learning activity can be scheduled. (GET /api/v2/learning/scheduleslots/jobs/{jobId}) Requires permission learning:scheduleSlotJob:view. The id is the jobId. Required: id.
- **genesys_cloud_learning_scheduleslots_search** — Get list of possible slots where a learning activity can be scheduled. (POST /api/v2/learning/scheduleslots/query) Requires permission learning:scheduleSlot:view. Required: interval, lengthInMinutes, userIds.
- **create_a_genesys_cloud_learning_scorm** — Create a SCORM package upload request. (POST /api/v2/learning/scorm) Requires permission learning:scorm:add. Required: contentMd5.
- **get_single_genesys_cloud_learning_scorm_by_id** — Get Learning SCORM Result. (GET /api/v2/learning/scorm/{scormId}) Requires permission learning:scorm:view. The id is the scormId. Required: id.
- **get_single_genesys_cloud_license_definition_by_id** — Get PureCloud license definition. (GET /api/v2/license/definitions/{licenseId}) Requires any of permissions authorization:grant:add, authorization:license:view. The id is the licenseId. Required: id.
- **list_all_genesys_cloud_license_definitions** — Get all PureCloud license definitions available for the organization. (GET /api/v2/license/definitions) Requires any of permissions authorization:grant:add, authorization:license:view.
- **create_a_genesys_cloud_license_infer** — Get a list of licenses inferred based on a list of roleIds. (POST /api/v2/license/infer)
- **create_a_genesys_cloud_license_organization** — Update the organization's license assignments in a batch. (POST /api/v2/license/organization) Requires permission authorization:grant:add. Required: assignments.
- **create_a_genesys_cloud_license_toggle** — Deprecated. No alternative required - this endpoint has no effect. (POST /api/v2/license/toggles/{featureName}) Required: feature_name.
- **get_single_genesys_cloud_license_toggle_by_id** — Deprecated - no alternative required. This operation will always return 'true' for requested toggles. (GET /api/v2/license/toggles/{featureName}) The id is the featureName. Required: id.
- **create_a_genesys_cloud_license_user** — Fetch user licenses in a batch. (POST /api/v2/license/users) Requires any of permissions authorization:grant:add, authorization:license:view.
- **get_single_genesys_cloud_license_user_by_id** — Get licenses for specified user. (GET /api/v2/license/users/{userId}) Requires any of permissions authorization:grant:add, authorization:license:view. The id is the userId. Required: id.
- **list_all_genesys_cloud_license_users** — Get a page of users and their licenses. Retrieve a page of users in an organization along with the licenses they possess. (GET /api/v2/license/users) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_location_search_lookup** — Search locations using the q64 value returned from a previous search. (GET /api/v2/locations/search) Required: q64.
- **list_all_genesys_cloud_location_sublocations** — Get sublocations for location ID. (GET /api/v2/locations/{locationId}/sublocations) Required: location_id.
- **create_a_genesys_cloud_location** — Create a location. (POST /api/v2/locations) Requires permission directory:location:add. Required: name.
- **delete_a_genesys_cloud_location_by_id** — Delete a location. (DELETE /api/v2/locations/{locationId}) Requires permission directory:location:delete. The id is the locationId. Required: id.
- **get_single_genesys_cloud_location_by_id** — Get Location by ID. (GET /api/v2/locations/{locationId}) The id is the locationId. Required: id.
- **list_all_genesys_cloud_locations** — Get a list of all locations. (GET /api/v2/locations) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_locations_search** — Search locations. (POST /api/v2/locations/search)
- **update_a_genesys_cloud_location_by_id** — Update a location. (PATCH /api/v2/locations/{locationId}) Requires permission directory:location:edit. The id is the locationId. Required: id, name, version.
- **list_all_genesys_cloud_notification_availabletopics** — Get available notification topics. (GET /api/v2/notifications/availabletopics)
- **genesys_cloud_notification_channel_subscriptions_bulk_delete** — Remove all subscriptions. (DELETE /api/v2/notifications/channels/{channelId}/subscriptions) Required: channel_id.
- **genesys_cloud_notification_channel_subscriptions_bulk_update** — Replace the current list of subscriptions with a new list. (PUT /api/v2/notifications/channels/{channelId}/subscriptions) Required: channel_id.
- **create_a_genesys_cloud_notification_channel_subscription** — Add a list of subscriptions to the existing list of subscriptions. (POST /api/v2/notifications/channels/{channelId}/subscriptions) Required: channel_id.
- **list_all_genesys_cloud_notification_channel_subscriptions** — The list of all subscriptions for this channel. (GET /api/v2/notifications/channels/{channelId}/subscriptions) Required: channel_id.
- **create_a_genesys_cloud_notification_channel** — Create a new channel. There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first. (POST /api/v2/notifications/channels)
- **list_all_genesys_cloud_notification_channels** — The list of existing channels. (GET /api/v2/notifications/channels)
- **get_single_genesys_cloud_oauth_authorization_by_id** — Get a client that is authorized by the resource owner. (GET /api/v2/oauth/authorizations/{clientId}) Requires permission oauth:client:authorize. The id is the clientId. Required: id.
- **list_all_genesys_cloud_oauth_authorizations** — List clients that have been authorized, requested, or revoked by the resource owner. (GET /api/v2/oauth/authorizations) Requires permission oauth:client:authorize.
- **create_a_genesys_cloud_oauth_client_secret** — Regenerate Client Secret. This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution. (POST /api/v2/oauth/clients/{clientId}/secret) Requires permission oauth:client:edit. Required: client_id.
- **create_a_genesys_cloud_oauth_client** — Create OAuth client. The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. (POST /api/v2/oauth/clients) Requires permission oauth:client:add. Required: name, authorizedGrantType.
- **delete_a_genesys_cloud_oauth_client_by_id** — Delete OAuth Client. (DELETE /api/v2/oauth/clients/{clientId}) Requires permission oauth:client:delete. The id is the clientId. Required: id.
- **get_single_genesys_cloud_oauth_client_by_id** — Get OAuth Client. (GET /api/v2/oauth/clients/{clientId}) Requires permission oauth:client:view. The id is the clientId. Required: id.
- **list_all_genesys_cloud_oauth_clients** — The list of OAuth clients. (GET /api/v2/oauth/clients) Requires permission oauth:client:view.
- **update_a_genesys_cloud_oauth_client_by_id** — Update OAuth Client. (PUT /api/v2/oauth/clients/{clientId}) Requires permission oauth:client:edit. The id is the clientId. Required: id, name, authorizedGrantType.
- **get_single_genesys_cloud_oauth_scope_by_id** — An OAuth scope. (GET /api/v2/oauth/scopes/{scopeId}) The id is the scopeId. Required: id.
- **list_all_genesys_cloud_oauth_scopes** — The list of OAuth scopes. (GET /api/v2/oauth/scopes)
- **organization_authentication_settings_bulk_partial_update** — Update the organization's settings. (PATCH /api/v2/organizations/authentication/settings) Requires permission directory:organization:admin.
- **genesys_cloud_organization_authentication_settings_lookup** — Gets the organization's settings. (GET /api/v2/organizations/authentication/settings) Requires permission directory:organization:admin.
- **update_a_genesys_cloud_organization_feature_by_id** — Update organization. (PATCH /api/v2/organizations/features/{featureName}) Requires permission directory:organization:admin. The id is the featureName. Required: id.
- **get_single_genesys_cloud_organization_limit_changerequest_by_id** — Get a limit change request. (GET /api/v2/organizations/limits/changerequests/{requestId}) Requires permission limits:organization:view. The id is the requestId. Required: id.
- **list_all_genesys_cloud_organization_limit_changerequests** — Get the available limit change requests. Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction. (GET /api/v2/organizations/limits/changerequests) Requires permission limits:organization:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_organization_limit_doc_freetrial** — Get free trial limit documentation. (GET /api/v2/organizations/limits/docs/freetrial)
- **genesys_cloud_organization_limit_docs_lookup** — Get limit documentation. (GET /api/v2/organizations/limits/docs)
- **list_all_genesys_cloud_organization_limit_namespace_defaults** — Get the default limits in a namespace for an organization. (GET /api/v2/organizations/limits/namespaces/{namespaceName}/defaults) Required: namespace_name.
- **get_single_genesys_cloud_organization_limit_namespace_by_id** — Get the effective limits in a namespace for an organization. (GET /api/v2/organizations/limits/namespaces/{namespaceName}) The id is the namespaceName. Required: id.
- **genesys_cloud_organization_limit_namespaces_lookup** — Get the available limit namespaces. (GET /api/v2/organizations/limits/namespaces)
- **genesys_cloud_organization_me_bulk_update** — Update organization. (PUT /api/v2/organizations/me) Requires permission directory:organization:admin. Required: version.
- **genesys_cloud_organization_me_lookup** — Get organization. (GET /api/v2/organizations/me)
- **create_a_genesys_cloud_orgauthorization_pairing** — A pairing id is created by the trustee and given to the trustor to create a trust. (POST /api/v2/orgauthorization/pairings) Requires permission authorization:orgTrustee:add.
- **get_single_genesys_cloud_orgauthorization_pairing_by_id** — Get Pairing Info. (GET /api/v2/orgauthorization/pairings/{pairingId}) Requires any of permissions authorization:orgTrustee:view, authorization:orgTrustor:view. The id is the pairingId. Required: id.
- **create_a_genesys_cloud_orgauthorization_trustee_audit** — Get Org Trustee Audits. (POST /api/v2/orgauthorization/trustees/audits) Requires permission authorization:audit:view. Required: trusteeOrganizationIds, trusteeUserIds.
- **create_a_genesys_cloud_orgauthorization_trustee_care** — Create a new organization authorization trust with Customer Care. (POST /api/v2/orgauthorization/trustees/care) Requires permissions authorization:orgTrustee:add, authorization:orgTrusteeUser:add.
- **list_all_genesys_cloud_orgauthorization_trustee_care** — Get Customer Care organization ids. (GET /api/v2/orgauthorization/trustees/care) Requires any of permissions authorization:orgTrustee:view, authorization:orgTrusteeUser:view.
- **delete_a_genesys_cloud_orgauthorization_trustee_cloneduser_by_id** — Deletes cloned user. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}) Requires permission directory:user:delete. The id is the trusteeUserId. Required: id, trustee_org_id.
- **list_all_genesys_cloud_orgauthorization_trustee_clonedusers** — The list of cloned users from the trustee organization (i.e. users with a native user record). There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers) Requires permission directory:user:view. Required: trustee_org_id.
- **create_a_genesys_cloud_orgauthorization_trustee_default** — Create a new organization authorization trust with Customer Care. (POST /api/v2/orgauthorization/trustees/default) Requires permissions authorization:orgTrustee:add, authorization:orgTrusteeUser:add.
- **genesys_cloud_orgauthorization_trustee_default_lookup** — Get organization authorization trust with Customer Care, if one exists. (GET /api/v2/orgauthorization/trustees/default) Requires any of permissions authorization:orgTrustee:view, authorization:orgTrusteeUser:view.
- **orgauthorization_trustee_group_roledivisions_bulk_update** — Update Trustee Group Roles. (PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions) Requires permission authorization:orgTrusteeGroup:edit. Required: trustee_org_id, trustee_group_id, grants.
- **genesys_cloud_orgauthorization_trustee_group_roles_bulk_delete** — Delete Trustee Group Roles. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles) Requires permission authorization:orgTrusteeGroup:delete. Required: trustee_org_id, trustee_group_id.
- **genesys_cloud_orgauthorization_trustee_group_roles_bulk_update** — Update Trustee Group Roles. (PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles) Requires permission authorization:orgTrusteeGroup:edit. Required: trustee_org_id, trustee_group_id.
- **genesys_cloud_orgauthorization_trustee_group_roles_lookup** — Get Trustee Group Roles. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles) Requires permission authorization:orgTrusteeGroup:view. Required: trustee_org_id, trustee_group_id.
- **create_a_genesys_cloud_orgauthorization_trustee_group** — Add a group to the trust. (POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups) Requires permission authorization:orgTrusteeGroup:add. Required: trustee_org_id, id.
- **delete_a_genesys_cloud_orgauthorization_trustee_group_by_id** — Delete Trustee Group. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}) Requires permission authorization:orgTrusteeGroup:delete. The id is the trusteeGroupId. Required: id, trustee_org_id.
- **get_single_genesys_cloud_orgauthorization_trustee_group_by_id** — Get Trustee Group. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}) Requires permission authorization:orgTrusteeGroup:view. The id is the trusteeGroupId. Required: id, trustee_org_id.
- **list_all_genesys_cloud_orgauthorization_trustee_groups** — The list of trustee groups for this organization (i.e. groups granted access to this organization). (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups) Requires permission authorization:orgTrusteeGroup:view. Pages automatically with pageNumber/pageSize. Required: trustee_org_id.
- **orgauthorization_trustee_user_roledivisions_bulk_update** — Update Trustee User Roles. (PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions) Requires permission authorization:orgTrusteeUser:edit. Required: trustee_org_id, trustee_user_id, grants.
- **genesys_cloud_orgauthorization_trustee_user_roles_bulk_delete** — Delete Trustee User Roles. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles) Requires permission authorization:orgTrusteeUser:delete. Required: trustee_org_id, trustee_user_id.
- **genesys_cloud_orgauthorization_trustee_user_roles_bulk_update** — Update Trustee User Roles. (PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles) Requires permission authorization:orgTrusteeUser:edit. Required: trustee_org_id, trustee_user_id.
- **genesys_cloud_orgauthorization_trustee_user_roles_lookup** — Get Trustee User Roles. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles) Requires permission authorization:orgTrusteeUser:view. Required: trustee_org_id, trustee_user_id.
- **create_a_genesys_cloud_orgauthorization_trustee_user** — Add a user to the trust. (POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users) Requires permission authorization:orgTrusteeUser:add. Required: trustee_org_id, id.
- **delete_a_genesys_cloud_orgauthorization_trustee_user_by_id** — Delete Trustee User. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}) Requires permission authorization:orgTrusteeUser:delete. The id is the trusteeUserId. Required: id, trustee_org_id.
- **get_single_genesys_cloud_orgauthorization_trustee_user_by_id** — Get Trustee User. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}) Requires permission authorization:orgTrusteeUser:view. The id is the trusteeUserId. Required: id, trustee_org_id.
- **list_all_genesys_cloud_orgauthorization_trustee_users** — The list of trustee users for this organization (i.e. users granted access to this organization). (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users) Requires permission authorization:orgTrusteeUser:view. Pages automatically with pageNumber/pageSize. Required: trustee_org_id.
- **create_a_genesys_cloud_orgauthorization_trustee** — Create a new organization authorization trust. This is required to grant other organizations access to your organization. (POST /api/v2/orgauthorization/trustees) Requires permissions authorization:orgTrustee:add, authorization:orgTrusteeUser:add. Required: enabled.
- **delete_a_genesys_cloud_orgauthorization_trustee_by_id** — Delete Org Trust. (DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}) Requires permission authorization:orgTrustee:delete. The id is the trusteeOrgId. Required: id.
- **get_single_genesys_cloud_orgauthorization_trustee_by_id** — Get Org Trust. (GET /api/v2/orgauthorization/trustees/{trusteeOrgId}) Requires permission authorization:orgTrustee:view. The id is the trusteeOrgId. Required: id.
- **list_all_genesys_cloud_orgauthorization_trustees** — The list of trustees for this organization (i.e. organizations granted access to this organization). (GET /api/v2/orgauthorization/trustees) Requires permission authorization:orgTrustee:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_orgauthorization_trustee_by_id** — Update Org Trust. (PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}) Requires permission authorization:orgTrustee:edit. The id is the trusteeOrgId. Required: id, enabled.
- **create_a_genesys_cloud_orgauthorization_trustor_audit** — Get Org Trustor Audits. (POST /api/v2/orgauthorization/trustor/audits) Requires permission authorization:audit:view. Required: trustorOrganizationId, trusteeUserIds.
- **delete_a_genesys_cloud_orgauthorization_trustor_cloneduser_by_id** — Delete Cloned User. (DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}) Requires any of permissions authorization:orgTrusteeClonedUser:delete, authorization:orgTrusteeUser:delete. The id is the trusteeUserId. Required: id, trustor_org_id.
- **get_orgauthorization_trustor_cloneduser_by_id** — Get Cloned User. (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}) Requires any of permissions authorization:orgTrusteeClonedUser:view, authorization:orgTrusteeUser:view. The id is the trusteeUserId. Required: id, trustor_org_id.
- **list_all_genesys_cloud_orgauthorization_trustor_clonedusers** — The list of cloned users in the trustor organization (i.e. users with a native user record). (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers) Requires any of permissions authorization:orgTrusteeClonedUser:view, authorization:orgTrusteeUser:view. Required: trustor_org_id.
- **update_a_genesys_cloud_orgauthorization_trustor_cloneduser_by_id** — Creates a clone of the trustee user in the trustor org. (PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}) Requires any of permissions authorization:orgTrusteeClonedUser:add, authorization:orgTrusteeUser:add. The id is the trusteeUserId. Required: id, trustor_org_id.
- **delete_a_genesys_cloud_orgauthorization_trustor_group_by_id** — Delete Trustee Group. (DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}) Requires permission authorization:orgTrusteeGroup:delete. The id is the trustorGroupId. Required: id, trustor_org_id.
- **get_single_genesys_cloud_orgauthorization_trustor_group_by_id** — Get Trustee Group. (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}) Requires permission authorization:orgTrusteeGroup:view. The id is the trustorGroupId. Required: id, trustor_org_id.
- **list_all_genesys_cloud_orgauthorization_trustor_groups** — The list of groups in the trustor organization (i.e. groups granted access). (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups) Requires permission authorization:orgTrusteeGroup:view. Pages automatically with pageNumber/pageSize. Required: trustor_org_id.
- **update_a_genesys_cloud_orgauthorization_trustor_group_by_id** — Add a Trustee Group to the trust. (PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId}) Requires permission authorization:orgTrusteeGroup:add. The id is the trustorGroupId. Required: id, trustor_org_id.
- **delete_a_genesys_cloud_orgauthorization_trustor_user_by_id** — Delete Trustee User. (DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}) Requires permission authorization:orgTrusteeUser:delete. The id is the trusteeUserId. Required: id, trustor_org_id.
- **get_single_genesys_cloud_orgauthorization_trustor_user_by_id** — Get Trustee User. (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}) Requires permission authorization:orgTrusteeUser:view. The id is the trusteeUserId. Required: id, trustor_org_id.
- **list_all_genesys_cloud_orgauthorization_trustor_users** — The list of users in the trustor organization (i.e. users granted access). (GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users) Requires permission authorization:orgTrusteeUser:view. Pages automatically with pageNumber/pageSize. Required: trustor_org_id.
- **update_a_genesys_cloud_orgauthorization_trustor_user_by_id** — Add a Trustee user to the trust. (PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}) Requires permission authorization:orgTrusteeUser:add. The id is the trusteeUserId. Required: id, trustor_org_id.
- **delete_a_genesys_cloud_orgauthorization_trustor_by_id** — Delete Org Trust. (DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}) Requires permission authorization:orgTrustor:delete. The id is the trustorOrgId. Required: id.
- **get_single_genesys_cloud_orgauthorization_trustor_by_id** — Get Org Trust. (GET /api/v2/orgauthorization/trustors/{trustorOrgId}) Requires permission authorization:orgTrustor:view. The id is the trustorOrgId. Required: id.
- **list_all_genesys_cloud_orgauthorization_trustors** — The list of organizations that have authorized/trusted your organization. (GET /api/v2/orgauthorization/trustors) Requires permission authorization:orgTrustor:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_orphanrecording_media_lookup** — Gets the media of a single orphan recording. A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body. (GET /api/v2/orphanrecordings/{orphanId}/media) Requires permission recording:orphan:view. Required: orphan_id.
- **delete_a_genesys_cloud_orphanrecording_by_id** — Deletes a single orphan recording. (DELETE /api/v2/orphanrecordings/{orphanId}) Requires permission recording:orphan:delete. The id is the orphanId. Required: id.
- **get_single_genesys_cloud_orphanrecording_by_id** — Gets a single orphan recording. (GET /api/v2/orphanrecordings/{orphanId}) Requires permission recording:orphan:view. The id is the orphanId. Required: id.
- **list_all_genesys_cloud_orphanrecordings** — Gets all orphan recordings. When querying without 'hasConversation = true', the results are capped at 500 orphan recordings. (GET /api/v2/orphanrecordings) Requires permission recording:orphan:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_orphanrecording_by_id** — Updates an orphan recording to a regular recording with retention values. If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api. (PUT /api/v2/orphanrecordings/{orphanId}) Requires permission recording:orphan:edit. The id is the orphanId. Required: id.
- **create_a_genesys_cloud_outbound_attemptlimit** — Create attempt limits. (POST /api/v2/outbound/attemptlimits) Requires permission outbound:attemptLimits:add.
- **delete_a_genesys_cloud_outbound_attemptlimit_by_id** — Delete attempt limits. (DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId}) Requires permission outbound:attemptLimits:delete. The id is the attemptLimitsId. Required: id.
- **get_single_genesys_cloud_outbound_attemptlimit_by_id** — Get attempt limits. (GET /api/v2/outbound/attemptlimits/{attemptLimitsId}) Requires permission outbound:attemptLimits:view. The id is the attemptLimitsId. Required: id.
- **list_all_genesys_cloud_outbound_attemptlimits** — Query attempt limits list. (GET /api/v2/outbound/attemptlimits) Requires permission outbound:attemptLimits:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_attemptlimit_by_id** — Update attempt limits. (PUT /api/v2/outbound/attemptlimits/{attemptLimitsId}) Requires permission outbound:attemptLimits:edit. The id is the attemptLimitsId. Required: id.
- **create_a_genesys_cloud_outbound_callabletimeset** — Create callable time set. (POST /api/v2/outbound/callabletimesets) Requires permission outbound:callableTimeSet:add. Required: name, callableTimes.
- **delete_a_genesys_cloud_outbound_callabletimeset_by_id** — Delete callable time set. (DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId}) Requires permission outbound:callableTimeSet:delete. The id is the callableTimeSetId. Required: id.
- **get_single_genesys_cloud_outbound_callabletimeset_by_id** — Get callable time set. (GET /api/v2/outbound/callabletimesets/{callableTimeSetId}) Requires permission outbound:callableTimeSet:view. The id is the callableTimeSetId. Required: id.
- **list_all_genesys_cloud_outbound_callabletimesets** — Query callable time set list. (GET /api/v2/outbound/callabletimesets) Requires permission outbound:callableTimeSet:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_callabletimeset_by_id** — Update callable time set. (PUT /api/v2/outbound/callabletimesets/{callableTimeSetId}) Requires permission outbound:callableTimeSet:edit. The id is the callableTimeSetId. Required: id, name, callableTimes.
- **create_a_genesys_cloud_outbound_callanalysisresponseset** — Create a dialer call analysis response set. (POST /api/v2/outbound/callanalysisresponsesets) Requires permission outbound:responseSet:add. Required: name, responses.
- **delete_a_genesys_cloud_outbound_callanalysisresponseset_by_id** — Delete a dialer call analysis response set. (DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}) Requires permission outbound:responseSet:delete. The id is the callAnalysisSetId. Required: id.
- **get_single_genesys_cloud_outbound_callanalysisresponseset_by_id** — Get a dialer call analysis response set. (GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}) Requires permission outbound:responseSet:view. The id is the callAnalysisSetId. Required: id.
- **list_all_genesys_cloud_outbound_callanalysisresponsesets** — Query a list of dialer call analysis response sets. (GET /api/v2/outbound/callanalysisresponsesets) Requires permission outbound:responseSet:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_callanalysisresponseset_by_id** — Update a dialer call analysis response set. (PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}) Requires permission outbound:responseSet:edit. The id is the callAnalysisSetId. Required: id, name, responses.
- **create_outbound_campaign_agentownedmappingpreview** — Initiate request for a preview of how agents will be mapped to this campaign's contact list. (POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview) Requires permissions outbound:campaign:view, outbound:contact:view, directory:user:view. Required: campaign_id.
- **list_all_outbound_campaign_agentownedmappingpreview_results** — Get a preview of how agents will be mapped to this campaign's contact list. (GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results) Requires permissions outbound:campaign:view, outbound:contact:view, routing:queue:view. Required: campaign_id.
- **update_a_genesys_cloud_outbound_campaign_agent_by_id** — Send notification that an agent's state changed. New agent state. (PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId}) The id is the userId. Required: id, campaign_id.
- **list_all_genesys_cloud_outbound_campaign_all** — Query across all types of campaigns by division. (GET /api/v2/outbound/campaigns/all) Requires any of permissions outbound:campaign:view, outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_outbound_campaign_all_divisionviews** — Query across all types of campaigns. (GET /api/v2/outbound/campaigns/all/divisionviews) Requires any of permissions outbound:campaign:search, outbound:messagingCampaign:search, outbound:emailCampaign:search, outbound:whatsAppCampaign:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_campaign_diagnostics_lookup** — Get campaign diagnostics. (GET /api/v2/outbound/campaigns/{campaignId}/diagnostics) Requires permission outbound:campaign:view. Required: campaign_id.
- **get_single_genesys_cloud_outbound_campaign_divisionview_by_id** — Get a basic Campaign information object. This returns a simplified version of a Campaign, consisting of name and division. (GET /api/v2/outbound/campaigns/divisionviews/{campaignId}) Requires permission outbound:campaign:search. The id is the campaignId. Required: id.
- **list_all_genesys_cloud_outbound_campaign_divisionviews** — Query a list of basic Campaign information objects. This returns a simplified version of a Campaign, consisting of name and division. (GET /api/v2/outbound/campaigns/divisionviews) Requires permission outbound:campaign:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_campaign_interactions_lookup** — Get dialer campaign interactions. (GET /api/v2/outbound/campaigns/{campaignId}/interactions) Requires permission outbound:campaign:view. Required: campaign_id.
- **genesys_cloud_outbound_campaign_linedistribution_lookup** — Get line distribution information for campaigns using same Edge Group or Site as given campaign. (GET /api/v2/outbound/campaigns/{campaignId}/linedistribution) Requires permission outbound:lineDistribution:view. Required: campaign_id.
- **genesys_cloud_outbound_campaign_performance_search** — Get performance data for a list of campaigns. (POST /api/v2/outbound/campaigns/performance/query) Requires any of permissions outbound:performance:view, outbound:campaign:view.
- **genesys_cloud_outbound_campaign_progress_bulk_delete** — Reset campaign progress and recycle the campaign. (DELETE /api/v2/outbound/campaigns/{campaignId}/progress) Requires any of permissions outbound:campaign:edit, outbound:campaign:recycle. Required: campaign_id.
- **create_a_genesys_cloud_outbound_campaign_progress** — Get progress for a list of campaigns. (POST /api/v2/outbound/campaigns/progress) Requires permission outbound:campaign:view.
- **genesys_cloud_outbound_campaign_progress_lookup** — Get campaign progress. (GET /api/v2/outbound/campaigns/{campaignId}/progress) Requires permission outbound:campaign:view. Required: campaign_id.
- **list_all_genesys_cloud_outbound_campaign_skillcombinations** — Get the remaining and total contact count for each skill combination in a skills campaign. (GET /api/v2/outbound/campaigns/{campaignId}/skillcombinations) Requires permission outbound:campaign:view. Pages automatically with pageNumber/pageSize. Required: campaign_id.
- **genesys_cloud_outbound_campaign_stats_lookup** — Get statistics about a Dialer Campaign. (GET /api/v2/outbound/campaigns/{campaignId}/stats) Requires permission outbound:campaign:view. Required: campaign_id.
- **create_a_genesys_cloud_outbound_campaignrule** — Create Campaign Rule. (POST /api/v2/outbound/campaignrules) Requires permission outbound:campaignRule:add. Required: name, campaignRuleEntities, campaignRuleConditions, campaignRuleActions.
- **delete_a_genesys_cloud_outbound_campaignrule_by_id** — Delete Campaign Rule. (DELETE /api/v2/outbound/campaignrules/{campaignRuleId}) Requires permission outbound:campaignRule:delete. The id is the campaignRuleId. Required: id.
- **get_single_genesys_cloud_outbound_campaignrule_by_id** — Get Campaign Rule. (GET /api/v2/outbound/campaignrules/{campaignRuleId}) Requires permission outbound:campaignRule:view. The id is the campaignRuleId. Required: id.
- **list_all_genesys_cloud_outbound_campaignrules** — Query Campaign Rule list. (GET /api/v2/outbound/campaignrules) Requires permission outbound:campaignRule:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_campaignrule_by_id** — Update Campaign Rule. (PUT /api/v2/outbound/campaignrules/{campaignRuleId}) Requires permission outbound:campaignRule:edit. The id is the campaignRuleId. Required: id, name, campaignRuleEntities, campaignRuleConditions, campaignRuleActions.
- **create_a_genesys_cloud_outbound_campaign** — Create a campaign. (POST /api/v2/outbound/campaigns) Requires permission outbound:campaign:add. Required: name, contactList, dialingMode, phoneColumns, callerName, callerAddress.
- **delete_a_genesys_cloud_outbound_campaign_by_id** — Delete a campaign. (DELETE /api/v2/outbound/campaigns/{campaignId}) Requires permission outbound:campaign:delete. The id is the campaignId. Required: id.
- **get_single_genesys_cloud_outbound_campaign_by_id** — Get dialer campaign. (GET /api/v2/outbound/campaigns/{campaignId}) Requires permission outbound:campaign:view. The id is the campaignId. Required: id.
- **list_all_genesys_cloud_outbound_campaigns** — Query a list of dialer campaigns. (GET /api/v2/outbound/campaigns) Requires permission outbound:campaign:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_campaigns_partial_update** — Update a campaign. (PATCH /api/v2/outbound/campaigns/{campaignId}) Requires permission outbound:campaign:edit. Required: campaign_id.
- **genesys_cloud_outbound_campaigns_start** — Start the campaign. (POST /api/v2/outbound/campaigns/{campaignId}/start) Requires permission outbound:campaign:start. Required: campaign_id.
- **genesys_cloud_outbound_campaigns_stop** — Stop the campaign. (POST /api/v2/outbound/campaigns/{campaignId}/stop) Requires permission outbound:campaign:stop. Required: campaign_id.
- **update_a_genesys_cloud_outbound_campaign_by_id** — Update a campaign. (PUT /api/v2/outbound/campaigns/{campaignId}) Requires permission outbound:campaign:edit. The id is the campaignId. Required: id, name, contactList, dialingMode, phoneColumns, callerName, callerAddress.
- **create_a_genesys_cloud_outbound_contactlist_bulk_update** — Bulk update contact lists. A maximum of 100 contact lists can be updated per request. (POST /api/v2/outbound/contactlists/bulk/update) Requires permission outbound:contactList:edit.
- **create_a_genesys_cloud_outbound_contactlist_clear** — Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be…. (POST /api/v2/outbound/contactlists/{contactListId}/clear) Requires permission outbound:contact:delete. Required: contact_list_id.
- **create_a_genesys_cloud_outbound_contactlist_contact_bulk** — Get contacts from a contact list. (POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk) Requires permission outbound:contact:view. Required: contact_list_id.
- **get_outbound_contactlist_contact_bulk_job_by_id** — Get bulk operation job. (GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}) Requires permission outbound:contactList:view. The id is the jobId. Required: id, contact_list_id.
- **list_all_genesys_cloud_outbound_contactlist_contact_bulk_jobs** — Get 10 most recent bulk operation jobs associated with contact list. (GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs) Requires permission outbound:contactList:view. Required: contact_list_id.
- **create_a_genesys_cloud_outbound_contactlist_contact_bulk_remove** — Start an async job to delete contacts using a filter. (POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove) Requires permission outbound:contact:delete. Required: contact_list_id.
- **create_a_genesys_cloud_outbound_contactlist_contact_bulk_update** — Start an async job to bulk edit contacts. (POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update) Requires permission outbound:contact:edit. Required: contact_list_id.
- **genesys_cloud_outbound_contactlist_contacts_bulk_delete** — Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted. (DELETE /api/v2/outbound/contactlists/{contactListId}/contacts) Requires permission outbound:contact:delete. Required: contact_list_id, contactIds.
- **create_a_genesys_cloud_outbound_contactlist_contact** — Add contacts to a contact list. (POST /api/v2/outbound/contactlists/{contactListId}/contacts) Requires permission outbound:contact:add. Required: contact_list_id.
- **delete_a_genesys_cloud_outbound_contactlist_contact_by_id** — Delete a contact. (DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}) Requires permission outbound:contact:delete. The id is the contactId. Required: id, contact_list_id.
- **get_single_genesys_cloud_outbound_contactlist_contact_by_id** — Get a contact. (GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}) Requires permission outbound:contact:view. The id is the contactId. Required: id, contact_list_id.
- **genesys_cloud_outbound_contactlist_contacts_search** — Query contacts from a contact list. (POST /api/v2/outbound/contactlists/{contactListId}/contacts/search) Requires permission outbound:contact:view. Required: contact_list_id, pageNumber, pageSize.
- **update_a_genesys_cloud_outbound_contactlist_contact_by_id** — Update a contact. (PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}) Requires permission outbound:contact:edit. The id is the contactId. Required: id, contact_list_id, contactListId, data.
- **get_single_genesys_cloud_outbound_contactlist_divisionview_by_id** — Get a basic ContactList information object. This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size. (GET /api/v2/outbound/contactlists/divisionviews/{contactListId}) Requires permission outbound:contactList:search. The id is the contactListId. Required: id.
- **list_all_genesys_cloud_outbound_contactlist_divisionviews** — Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size. (GET /api/v2/outbound/contactlists/divisionviews) Requires permission outbound:contactList:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_outbound_contactlist_export** — Initiate the export of a contact list. Returns 200 if received OK. (POST /api/v2/outbound/contactlists/{contactListId}/export) Requires permissions outbound:contact:view, outbound:contactList:view. Required: contact_list_id.
- **genesys_cloud_outbound_contactlist_export_lookup** — Get the URI of a contact list export. (GET /api/v2/outbound/contactlists/{contactListId}/export) Requires permissions outbound:contact:view, outbound:contactList:view. Required: contact_list_id.
- **genesys_cloud_outbound_contactlist_importstatus_lookup** — Get dialer contactList import status. (GET /api/v2/outbound/contactlists/{contactListId}/importstatus) Requires permission outbound:contactList:view. Required: contact_list_id.
- **genesys_cloud_outbound_contactlist_timezonemappingpreview_lookup** — Preview the result of applying Automatic Time Zone Mapping to a contact list. (GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview) Requires permission outbound:contactList:view. Required: contact_list_id.
- **create_a_genesys_cloud_outbound_contactlist_upload** — Generate presigned upload URL for contact list. (POST /api/v2/outbound/contactlists/uploads) Requires permission outbound:contactList:upload. Required: contentType.
- **create_a_genesys_cloud_outbound_contactlistfilter_bulk_retrieve** — Retrieve multiple contact list filters. (POST /api/v2/outbound/contactlistfilters/bulk/retrieve) Requires permission outbound:contactListFilter:view. Required: ids.
- **create_a_genesys_cloud_outbound_contactlistfilter** — Create Contact List Filter. (POST /api/v2/outbound/contactlistfilters) Requires permission outbound:contactListFilter:add. Required: name.
- **delete_a_genesys_cloud_outbound_contactlistfilter_by_id** — Delete Contact List Filter. (DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId}) Requires permission outbound:contactListFilter:delete. The id is the contactListFilterId. Required: id.
- **get_single_genesys_cloud_outbound_contactlistfilter_by_id** — Get Contact list filter. (GET /api/v2/outbound/contactlistfilters/{contactListFilterId}) Requires permission outbound:contactListFilter:view. The id is the contactListFilterId. Required: id.
- **list_all_genesys_cloud_outbound_contactlistfilters** — Query Contact list filters. (GET /api/v2/outbound/contactlistfilters) Requires permission outbound:contactListFilter:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_contactlistfilters_preview** — Get a preview of the output of a contact list filter. (POST /api/v2/outbound/contactlistfilters/preview) Requires permission outbound:contact:view. Required: name.
- **update_a_genesys_cloud_outbound_contactlistfilter_by_id** — Update Contact List Filter. (PUT /api/v2/outbound/contactlistfilters/{contactListFilterId}) Requires permission outbound:contactListFilter:edit. The id is the contactListFilterId. Required: id, name.
- **genesys_cloud_outbound_contactlists_bulk_delete** — Delete multiple contact lists. (DELETE /api/v2/outbound/contactlists) Requires permission outbound:contactList:delete. Required: id.
- **create_a_genesys_cloud_outbound_contactlist** — Create a contact List. (POST /api/v2/outbound/contactlists) Requires permission outbound:contactList:add. Required: columnNames.
- **delete_a_genesys_cloud_outbound_contactlist_by_id** — Delete a contact list. (DELETE /api/v2/outbound/contactlists/{contactListId}) Requires permission outbound:contactList:delete. The id is the contactListId. Required: id.
- **get_single_genesys_cloud_outbound_contactlist_by_id** — Get a dialer contact list. (GET /api/v2/outbound/contactlists/{contactListId}) Requires permission outbound:contactList:view. The id is the contactListId. Required: id.
- **list_all_genesys_cloud_outbound_contactlists** — Query a list of contact lists. Any ContactList field can be used as a query parameter to filter results. Multiple values can be specified for a field, and filter type prefixes can be used inline. Example: dateCreated=greaterthan:2025-01-01T00:00:00.000Z&dateCreated=lessthan:2027-01-01T00:00:00.000Z. (GET /api/v2/outbound/contactlists) Requires permission outbound:contactList:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_contactlist_by_id** — Update a contact list. (PUT /api/v2/outbound/contactlists/{contactListId}) Requires permission outbound:contactList:edit. The id is the contactListId. Required: id, columnNames.
- **create_a_genesys_cloud_outbound_contactlisttemplate_bulk_add** — Add multiple contact list templates. (POST /api/v2/outbound/contactlisttemplates/bulk/add) Requires permission outbound:contactListTemplate:add.
- **create_outbound_contactlisttemplate_bulk_retrieve** — Get multiple contact list templates. (POST /api/v2/outbound/contactlisttemplates/bulk/retrieve) Requires permission outbound:contactListTemplate:view. Required: ids.
- **genesys_cloud_outbound_contactlisttemplates_bulk_delete** — Delete multiple contact list templates. (DELETE /api/v2/outbound/contactlisttemplates) Requires permission outbound:contactListTemplate:delete. Required: id.
- **create_a_genesys_cloud_outbound_contactlisttemplate** — Create Contact List Template. (POST /api/v2/outbound/contactlisttemplates) Requires permission outbound:contactListTemplate:add. Required: columnNames.
- **delete_a_genesys_cloud_outbound_contactlisttemplate_by_id** — Delete Contact List Template. (DELETE /api/v2/outbound/contactlisttemplates/{contactListTemplateId}) Requires permission outbound:contactListTemplate:delete. The id is the contactListTemplateId. Required: id.
- **get_single_genesys_cloud_outbound_contactlisttemplate_by_id** — Get Contact List Template. (GET /api/v2/outbound/contactlisttemplates/{contactListTemplateId}) Requires permission outbound:contactListTemplate:view. The id is the contactListTemplateId. Required: id.
- **list_all_genesys_cloud_outbound_contactlisttemplates** — Query a list of contact list templates. (GET /api/v2/outbound/contactlisttemplates) Requires permission outbound:contactListTemplate:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_contactlisttemplate_by_id** — Update a contact list template. (PUT /api/v2/outbound/contactlisttemplates/{contactListTemplateId}) Requires permission outbound:contactListTemplate:edit. The id is the contactListTemplateId. Required: id, columnNames.
- **create_a_genesys_cloud_outbound_conversation_dnc** — Add phone numbers to a Dialer DNC list. (POST /api/v2/outbound/conversations/{conversationId}/dnc) Requires permission outbound:dnc:add. Required: conversation_id.
- **genesys_cloud_outbound_diagnostic_campaign_summary_lookup** — Get diagnostic summary for a single campaign. (GET /api/v2/outbound/diagnostics/campaigns/{campaignId}/summary) Requires permission outbound:campaignDiagnostic:view. Required: campaign_id, start, end.
- **create_a_genesys_cloud_outbound_digitalruleset** — Create an Outbound Digital Rule Set. (POST /api/v2/outbound/digitalrulesets) Requires permission outbound:digitalRuleSet:add. Required: rules.
- **delete_a_genesys_cloud_outbound_digitalruleset_by_id** — Delete an Outbound Digital Rule Set. (DELETE /api/v2/outbound/digitalrulesets/{digitalRuleSetId}) Requires permission outbound:digitalRuleSet:delete. The id is the digitalRuleSetId. Required: id.
- **get_single_genesys_cloud_outbound_digitalruleset_by_id** — Get an Outbound Digital Rule Set. (GET /api/v2/outbound/digitalrulesets/{digitalRuleSetId}) Requires permission outbound:digitalRuleSet:view. The id is the digitalRuleSetId. Required: id.
- **list_all_genesys_cloud_outbound_digitalrulesets** — Query a list of Outbound Digital Rule Sets. (GET /api/v2/outbound/digitalrulesets) Requires permission outbound:digitalRuleSet:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_digitalruleset_by_id** — Update an Outbound Digital Rule Set. (PUT /api/v2/outbound/digitalrulesets/{digitalRuleSetId}) Requires permission outbound:digitalRuleSet:edit. The id is the digitalRuleSetId. Required: id, rules.
- **outbound_dnclist_customexclusioncolumns_bulk_delete** — Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries. (DELETE /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns) Requires permission outbound:dnc:delete. Required: dnc_list_id.
- **outbound_dnclist_customexclusioncolumns_bulk_partial_update** — Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from. (PATCH /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns) Requires permission outbound:dnc:edit. Required: dnc_list_id.
- **get_single_genesys_cloud_outbound_dnclist_divisionview_by_id** — Get a basic DncList information object. This returns a simplified version of a DncList, consisting of the name, division, import status, and size. (GET /api/v2/outbound/dnclists/divisionviews/{dncListId}) Requires permission outbound:dncList:search. The id is the dncListId. Required: id.
- **list_all_genesys_cloud_outbound_dnclist_divisionviews** — Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size. (GET /api/v2/outbound/dnclists/divisionviews) Requires permission outbound:dncList:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_dnclist_emailaddresses_bulk_delete** — Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses. (DELETE /api/v2/outbound/dnclists/{dncListId}/emailaddresses) Requires permission outbound:dnc:delete. Required: dnc_list_id.
- **outbound_dnclist_emailaddresses_bulk_partial_update** — Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from. (PATCH /api/v2/outbound/dnclists/{dncListId}/emailaddresses) Requires permission outbound:dnc:edit. Required: dnc_list_id.
- **create_a_genesys_cloud_outbound_dnclist_emailaddress** — Add email addresses to a DNC list. Only Internal DNC lists may be appended to. (POST /api/v2/outbound/dnclists/{dncListId}/emailaddresses) Requires permission outbound:dnc:add. Required: dnc_list_id.
- **create_a_genesys_cloud_outbound_dnclist_export** — Initiate the export of a dnc list. Returns 200 if received OK. (POST /api/v2/outbound/dnclists/{dncListId}/export) Requires permissions outbound:dnc:view, outbound:dncList:view. Required: dnc_list_id.
- **genesys_cloud_outbound_dnclist_export_lookup** — Get the URI of a DNC list export. (GET /api/v2/outbound/dnclists/{dncListId}/export) Requires permissions outbound:dnc:view, outbound:dncList:view. Required: dnc_list_id.
- **genesys_cloud_outbound_dnclist_importstatus_lookup** — Get dialer dncList import status. (GET /api/v2/outbound/dnclists/{dncListId}/importstatus) Requires permission outbound:dncList:view. Required: dnc_list_id.
- **genesys_cloud_outbound_dnclist_phonenumbers_bulk_delete** — Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers. (DELETE /api/v2/outbound/dnclists/{dncListId}/phonenumbers) Requires permission outbound:dnc:delete. Required: dnc_list_id.
- **genesys_cloud_outbound_dnclist_phonenumbers_bulk_partial_update** — Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from. (PATCH /api/v2/outbound/dnclists/{dncListId}/phonenumbers) Requires permission outbound:dnc:edit. Required: dnc_list_id.
- **create_a_genesys_cloud_outbound_dnclist_phonenumber** — Add phone numbers to a DNC list. Only Internal DNC lists may be appended to. (POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers) Requires permission outbound:dnc:add. Required: dnc_list_id.
- **create_a_genesys_cloud_outbound_dnclist_upload** — Generate presigned upload URL for dnc list. (POST /api/v2/outbound/dnclists/uploads) Requires permission outbound:dncList:upload. Required: contentType, id.
- **genesys_cloud_outbound_dnclist_whatsappnumbers_bulk_delete** — Deletes all or expired whatsApp numbers from a DNC list. This operation is only for Internal DNC lists of whatsApp numbers. (DELETE /api/v2/outbound/dnclists/{dncListId}/whatsappnumbers) Requires permission outbound:dnc:delete. Required: dnc_list_id.
- **outbound_dnclist_whatsappnumbers_bulk_partial_update** — Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from. (PATCH /api/v2/outbound/dnclists/{dncListId}/whatsappnumbers) Requires permission outbound:dnc:edit. Required: dnc_list_id.
- **create_a_genesys_cloud_outbound_dnclist** — Create dialer DNC list. (POST /api/v2/outbound/dnclists) Requires permission outbound:dncList:add. Required: name, dncSourceType.
- **delete_a_genesys_cloud_outbound_dnclist_by_id** — Delete dialer DNC list. (DELETE /api/v2/outbound/dnclists/{dncListId}) Requires permission outbound:dncList:delete. The id is the dncListId. Required: id.
- **get_single_genesys_cloud_outbound_dnclist_by_id** — Get dialer DNC list. (GET /api/v2/outbound/dnclists/{dncListId}) Requires permission outbound:dncList:view. The id is the dncListId. Required: id.
- **list_all_genesys_cloud_outbound_dnclists** — Query dialer DNC lists. (GET /api/v2/outbound/dnclists) Requires permission outbound:dncList:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_dnclist_by_id** — Update dialer DNC list. (PUT /api/v2/outbound/dnclists/{dncListId}) Requires permission outbound:dncList:edit. The id is the dncListId. Required: id, name.
- **get_single_genesys_cloud_outbound_event_by_id** — Get Dialer Event. (GET /api/v2/outbound/events/{eventId}) Requires permission outbound:eventLog:view. The id is the eventId. Required: id.
- **list_all_genesys_cloud_outbound_events** — Query Event Logs. (GET /api/v2/outbound/events) Requires permission outbound:eventLog:view. Pages automatically with pageNumber/pageSize.
- **outbound_filespecificationtemplate_bulk_bulk_delete** — Delete multiple file specification templates. (DELETE /api/v2/outbound/filespecificationtemplates/bulk) Requires permission outbound:fileSpecificationTemplate:delete. Required: id.
- **create_a_genesys_cloud_outbound_filespecificationtemplate** — Create File Specification Template. (POST /api/v2/outbound/filespecificationtemplates) Requires permission outbound:fileSpecificationTemplate:add. Required: name, format.
- **delete_a_genesys_cloud_outbound_filespecificationtemplate_by_id** — Delete File Specification Template. (DELETE /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}) Requires permission outbound:fileSpecificationTemplate:delete. The id is the fileSpecificationTemplateId. Required: id.
- **get_outbound_filespecificationtemplate_by_id** — Get File Specification Template. (GET /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}) Requires permission outbound:fileSpecificationTemplate:view. The id is the fileSpecificationTemplateId. Required: id.
- **list_all_genesys_cloud_outbound_filespecificationtemplates** — Query File Specification Templates. (GET /api/v2/outbound/filespecificationtemplates) Requires permission outbound:fileSpecificationTemplate:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_filespecificationtemplate_by_id** — Update File Specification Template. (PUT /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId}) Requires permission outbound:fileSpecificationTemplate:edit. The id is the fileSpecificationTemplateId. Required: id, name, format.
- **create_a_genesys_cloud_outbound_importtemplate_bulk_add** — Add multiple import templates. (POST /api/v2/outbound/importtemplates/bulk/add) Requires permission outbound:importTemplate:add.
- **genesys_cloud_outbound_importtemplate_importstatus_lookup** — Get the import status for an import template. (GET /api/v2/outbound/importtemplates/{importTemplateId}/importstatus) Requires permission outbound:importTemplate:view. Required: import_template_id.
- **genesys_cloud_outbound_importtemplates_bulk_delete** — Delete multiple import templates. (DELETE /api/v2/outbound/importtemplates) Requires permission outbound:importTemplate:delete. Required: id.
- **create_a_genesys_cloud_outbound_importtemplate** — Create Import Template. (POST /api/v2/outbound/importtemplates) Requires permission outbound:importTemplate:add. Required: contactListTemplate.
- **delete_a_genesys_cloud_outbound_importtemplate_by_id** — Delete Import Template. (DELETE /api/v2/outbound/importtemplates/{importTemplateId}) Requires permission outbound:importTemplate:delete. The id is the importTemplateId. Required: id.
- **get_single_genesys_cloud_outbound_importtemplate_by_id** — Get Import Template. (GET /api/v2/outbound/importtemplates/{importTemplateId}) Requires permission outbound:importTemplate:view. The id is the importTemplateId. Required: id.
- **list_all_genesys_cloud_outbound_importtemplates** — Query Import Templates. (GET /api/v2/outbound/importtemplates) Requires permission outbound:importTemplate:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_importtemplate_by_id** — Update Import Template. (PUT /api/v2/outbound/importtemplates/{importTemplateId}) Requires permission outbound:importTemplate:edit. The id is the importTemplateId. Required: id, contactListTemplate.
- **genesys_cloud_outbound_messagingcampaign_diagnostics_lookup** — Get messaging campaign diagnostics. (GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics) Requires any of permissions outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view. Required: messaging_campaign_id.
- **get_outbound_messagingcampaign_divisionview_by_id** — Get a basic Messaging Campaign information object. This returns a simplified version of a Messaging Campaign, consisting of id, name, and division. (GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaign:search, outbound:emailCampaign:search, outbound:whatsAppCampaign:search. The id is the messagingCampaignId. Required: id.
- **list_all_genesys_cloud_outbound_messagingcampaign_divisionviews** — Query a list of basic Messaging Campaign information objects. This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division. (GET /api/v2/outbound/messagingcampaigns/divisionviews) Requires any of permissions outbound:messagingCampaign:search, outbound:emailCampaign:search, outbound:whatsAppCampaign:search. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_messagingcampaign_progress_bulk_delete** — Reset messaging campaign progress and recycle the messaging campaign. Documented permissions are applicable based on campaign type. (DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress) Requires any of permissions outbound:messagingCampaign:edit, outbound:messagingCampaign:recycle, outbound:emailCampaign:edit, outbound:emailCampaign:recycle …. Required: messaging_campaign_id.
- **create_a_genesys_cloud_outbound_messagingcampaign_progress** — Get progress for a list of messaging campaigns. (POST /api/v2/outbound/messagingcampaigns/progress) Requires any of permissions outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view.
- **genesys_cloud_outbound_messagingcampaign_progress_lookup** — Get messaging campaign's progress. (GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress) Requires any of permissions outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view. Required: messaging_campaign_id.
- **create_a_genesys_cloud_outbound_messagingcampaign** — Create a Messaging Campaign. (POST /api/v2/outbound/messagingcampaigns) Requires any of permissions outbound:messagingCampaign:add, outbound:emailCampaign:add, outbound:whatsAppCampaign:add. Required: contactList, messagesPerMinute.
- **delete_a_genesys_cloud_outbound_messagingcampaign_by_id** — Delete an Outbound Messaging Campaign. (DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaign:delete, outbound:emailCampaign:delete, outbound:whatsAppCampaign:delete. The id is the messagingCampaignId. Required: id.
- **get_single_genesys_cloud_outbound_messagingcampaign_by_id** — Get an Outbound Messaging Campaign. (GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view. The id is the messagingCampaignId. Required: id.
- **list_all_genesys_cloud_outbound_messagingcampaigns** — Query a list of Messaging Campaigns. (GET /api/v2/outbound/messagingcampaigns) Requires any of permissions outbound:messagingCampaign:view, outbound:emailCampaign:view, outbound:whatsAppCampaign:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_outbound_messagingcampaigns_start** — Start the campaign. Documented permissions are applicable based on campaign type. (POST /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/start) Requires any of permissions outbound:messagingCampaign:start, outbound:emailCampaign:start, outbound:whatsAppCampaign:start. Required: messaging_campaign_id.
- **genesys_cloud_outbound_messagingcampaigns_stop** — Stop the campaign. Documented permissions are applicable based on campaign type. (POST /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop) Requires any of permissions outbound:messagingCampaign:stop, outbound:emailCampaign:stop, outbound:whatsAppCampaign:stop. Required: messaging_campaign_id.
- **update_a_genesys_cloud_outbound_messagingcampaign_by_id** — Update an Outbound Messaging Campaign. (PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaign:edit, outbound:emailCampaign:edit, outbound:whatsAppCampaign:edit. The id is the messagingCampaignId. Required: id, contactList, messagesPerMinute.
- **create_a_genesys_cloud_outbound_ruleset** — Create a Rule Set. (POST /api/v2/outbound/rulesets) Requires permission outbound:ruleSet:add. Required: name, rules.
- **delete_a_genesys_cloud_outbound_ruleset_by_id** — Delete a Rule Set. (DELETE /api/v2/outbound/rulesets/{ruleSetId}) Requires permission outbound:ruleSet:delete. The id is the ruleSetId. Required: id.
- **get_single_genesys_cloud_outbound_ruleset_by_id** — Get a Rule Set by ID. (GET /api/v2/outbound/rulesets/{ruleSetId}) Requires permission outbound:ruleSet:view. The id is the ruleSetId. Required: id.
- **list_all_genesys_cloud_outbound_rulesets** — Query a list of Rule Sets. (GET /api/v2/outbound/rulesets) Requires permission outbound:ruleSet:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_ruleset_by_id** — Update a Rule Set. (PUT /api/v2/outbound/rulesets/{ruleSetId}) Requires permission outbound:ruleSet:edit. The id is the ruleSetId. Required: id, name, rules.
- **delete_a_genesys_cloud_outbound_schedule_campaign_by_id** — Delete a dialer campaign schedule. (DELETE /api/v2/outbound/schedules/campaigns/{campaignId}) Requires any of permissions outbound:schedule:delete, outbound:campaign:deleteSchedule. The id is the campaignId. Required: id.
- **get_single_genesys_cloud_outbound_schedule_campaign_by_id** — Get a dialer campaign schedule. (GET /api/v2/outbound/schedules/campaigns/{campaignId}) Requires any of permissions outbound:schedule:view, outbound:campaign:viewSchedule. The id is the campaignId. Required: id.
- **list_all_genesys_cloud_outbound_schedule_campaigns** — Query for a list of dialer campaign schedules. (GET /api/v2/outbound/schedules/campaigns) Requires any of permissions outbound:schedule:view, outbound:campaign:viewSchedule.
- **update_a_genesys_cloud_outbound_schedule_campaign_by_id** — Update a new campaign schedule. (PUT /api/v2/outbound/schedules/campaigns/{campaignId}) Requires any of permissions outbound:schedule:edit, outbound:campaign:editSchedule. The id is the campaignId. Required: id, intervals, campaign.
- **delete_a_genesys_cloud_outbound_schedule_emailcampaign_by_id** — Delete an email campaign schedule. (DELETE /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}) Requires any of permissions outbound:emailCampaignSchedule:delete, outbound:emailCampaign:deleteSchedule. The id is the emailCampaignId. Required: id.
- **get_single_genesys_cloud_outbound_schedule_emailcampaign_by_id** — Get an email campaign schedule. (GET /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}) Requires any of permissions outbound:emailCampaignSchedule:view, outbound:emailCampaign:viewSchedule. The id is the emailCampaignId. Required: id.
- **list_all_genesys_cloud_outbound_schedule_emailcampaigns** — Query for a list of email campaign schedules. (GET /api/v2/outbound/schedules/emailcampaigns) Requires any of permissions outbound:emailCampaignSchedule:view, outbound:emailCampaign:viewSchedule.
- **update_a_genesys_cloud_outbound_schedule_emailcampaign_by_id** — Update an email campaign schedule. (PUT /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}) Requires any of permissions outbound:emailCampaignSchedule:edit, outbound:emailCampaign:editSchedule. The id is the emailCampaignId. Required: id, intervals, emailCampaign.
- **delete_a_genesys_cloud_outbound_schedule_messagingcampaign_by_id** — Delete a messaging campaign schedule. (DELETE /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaignSchedule:delete, outbound:messagingCampaign:deleteSchedule. The id is the messagingCampaignId. Required: id.
- **get_outbound_schedule_messagingcampaign_by_id** — Get a messaging campaign schedule. (GET /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaignSchedule:view, outbound:messagingCampaign:viewSchedule. The id is the messagingCampaignId. Required: id.
- **list_all_genesys_cloud_outbound_schedule_messagingcampaigns** — Query for a list of messaging campaign schedules. (GET /api/v2/outbound/schedules/messagingcampaigns) Requires any of permissions outbound:messagingCampaignSchedule:view, outbound:messagingCampaign:viewSchedule.
- **update_a_genesys_cloud_outbound_schedule_messagingcampaign_by_id** — Update a new messaging campaign schedule. (PUT /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}) Requires any of permissions outbound:messagingCampaignSchedule:edit, outbound:messagingCampaign:editSchedule. The id is the messagingCampaignId. Required: id, intervals, messagingCampaign.
- **delete_a_genesys_cloud_outbound_schedule_sequence_by_id** — Delete a dialer sequence schedule. (DELETE /api/v2/outbound/schedules/sequences/{sequenceId}) Requires any of permissions outbound:schedule:delete, outbound:campaignSequenceSchedule:delete. The id is the sequenceId. Required: id.
- **get_single_genesys_cloud_outbound_schedule_sequence_by_id** — Get a dialer sequence schedule. (GET /api/v2/outbound/schedules/sequences/{sequenceId}) Requires any of permissions outbound:schedule:view, outbound:campaignSequenceSchedule:view. The id is the sequenceId. Required: id.
- **list_all_genesys_cloud_outbound_schedule_sequences** — Query for a list of dialer sequence schedules. (GET /api/v2/outbound/schedules/sequences) Requires any of permissions outbound:schedule:view, outbound:campaignSequenceSchedule:view.
- **update_a_genesys_cloud_outbound_schedule_sequence_by_id** — Update a new sequence schedule. (PUT /api/v2/outbound/schedules/sequences/{sequenceId}) Requires any of permissions outbound:schedule:edit, outbound:campaignSequenceSchedule:edit. The id is the sequenceId. Required: id, intervals, sequence.
- **delete_a_genesys_cloud_outbound_schedule_whatsappcampaign_by_id** — Delete a WhatsApp campaign schedule. (DELETE /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}) Requires any of permissions outbound:whatsAppCampaignSchedule:delete, outbound:whatsAppCampaign:deleteSchedule. The id is the whatsAppCampaignId. Required: id.
- **get_outbound_schedule_whatsappcampaign_by_id** — Get a WhatsApp campaign schedule. (GET /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}) Requires any of permissions outbound:whatsAppCampaignSchedule:view, outbound:whatsAppCampaign:viewSchedule. The id is the whatsAppCampaignId. Required: id.
- **list_all_genesys_cloud_outbound_schedule_whatsappcampaigns** — Query for a list of WhatsApp campaign schedules. (GET /api/v2/outbound/schedules/whatsappcampaigns) Requires any of permissions outbound:whatsAppCampaignSchedule:view, outbound:whatsAppCampaign:viewSchedule.
- **update_a_genesys_cloud_outbound_schedule_whatsappcampaign_by_id** — Update a WhatsApp campaign schedule. (PUT /api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}) Requires any of permissions outbound:whatsAppCampaignSchedule:edit, outbound:whatsAppCampaign:editSchedule. The id is the whatsAppCampaignId. Required: id, intervals, whatsAppCampaign.
- **create_a_genesys_cloud_outbound_sequence** — Create a new campaign sequence. (POST /api/v2/outbound/sequences) Requires permission outbound:campaignSequence:add. Required: campaigns, status.
- **delete_a_genesys_cloud_outbound_sequence_by_id** — Delete a dialer campaign sequence. (DELETE /api/v2/outbound/sequences/{sequenceId}) Requires permission outbound:campaignSequence:delete. The id is the sequenceId. Required: id.
- **get_single_genesys_cloud_outbound_sequence_by_id** — Get a dialer campaign sequence. (GET /api/v2/outbound/sequences/{sequenceId}) Requires permission outbound:campaignSequence:view. The id is the sequenceId. Required: id.
- **list_all_genesys_cloud_outbound_sequences** — Query a list of dialer campaign sequences. (GET /api/v2/outbound/sequences) Requires permission outbound:campaignSequence:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_outbound_sequence_by_id** — Update a new campaign sequence. (PUT /api/v2/outbound/sequences/{sequenceId}) Requires permission outbound:campaignSequence:edit. The id is the sequenceId. Required: id, campaigns, status.
- **genesys_cloud_outbound_settings_bulk_partial_update** — Update the outbound settings for this organization. (PATCH /api/v2/outbound/settings) Requires permission outbound:settings:edit.
- **genesys_cloud_outbound_settings_lookup** — Get the outbound settings for this organization. (GET /api/v2/outbound/settings) Requires permission outbound:settings:view.
- **genesys_cloud_outbound_wrapupcodemappings_bulk_update** — Update the Dialer wrap up code mapping. (PUT /api/v2/outbound/wrapupcodemappings) Requires permission outbound:wrapUpCodeMapping:edit.
- **genesys_cloud_outbound_wrapupcodemappings_lookup** — Get the Dialer wrap up code mapping. (GET /api/v2/outbound/wrapupcodemappings) Requires permission outbound:wrapUpCodeMapping:view.
- **create_a_genesys_cloud_presence_definition** — Create a Presence Definition. (POST /api/v2/presence/definitions) Requires permission presence:presenceDefinition:add. Required: languageLabels.
- **delete_a_genesys_cloud_presence_definition_by_id** — Delete a Presence Definition. (DELETE /api/v2/presence/definitions/{definitionId}) Requires any of permissions presence:presenceDefinition:delete, presence:presenceDefinition:edit. The id is the definitionId. Required: id.
- **get_single_genesys_cloud_presence_definition_by_id** — Get a Presence Definition. (GET /api/v2/presence/definitions/{definitionId}) Requires permission presence:presenceDefinition:view. The id is the definitionId. Required: id.
- **list_all_genesys_cloud_presence_definitions** — Get a list of Presence Definitions. View permission enforcement only applies to presence definitions assigned to a division. (GET /api/v2/presence/definitions) Requires permission presence:presenceDefinition:view.
- **update_a_genesys_cloud_presence_definition_by_id** — Update a Presence Definition. (PUT /api/v2/presence/definitions/{definitionId}) Requires permission presence:presenceDefinition:edit. The id is the definitionId. Required: id, languageLabels.
- **genesys_cloud_presence_settings_bulk_update** — Update the presence settings. (PUT /api/v2/presence/settings) Requires permission presence:settings:edit.
- **genesys_cloud_presence_settings_lookup** — Get the presence settings. (GET /api/v2/presence/settings) Requires permission presence:settings:view.
- **create_a_genesys_cloud_presence_source** — Create a Presence Source. (POST /api/v2/presence/sources) Requires permission presence:source:add. Required: name.
- **delete_a_genesys_cloud_presence_source_by_id** — Delete a Presence Source. (DELETE /api/v2/presence/sources/{sourceId}) Requires any of permissions presence:source:delete, presence:source:edit. The id is the sourceId. Required: id.
- **get_single_genesys_cloud_presence_source_by_id** — Get a Presence Source. (GET /api/v2/presence/sources/{sourceId}) Requires permission presence:source:view. The id is the sourceId. Required: id.
- **list_all_genesys_cloud_presence_sources** — Get a list of Presence Sources. (GET /api/v2/presence/sources) Requires permission presence:source:view.
- **update_a_genesys_cloud_presence_source_by_id** — Update a Presence Source. (PUT /api/v2/presence/sources/{sourceId}) Requires permission presence:source:edit. The id is the sourceId. Required: id, name.
- **genesys_cloud_presence_user_primarysource_bulk_update** — Update a user's Primary Presence Source. (PUT /api/v2/presence/users/{userId}/primarysource) Requires permission presence:userPrimarySource:edit. Required: user_id.
- **genesys_cloud_presence_user_primarysource_lookup** — Get a user's Primary Presence Source. (GET /api/v2/presence/users/{userId}/primarysource) Requires permission presence:userPrimarySource:view. Required: user_id.
- **create_a_genesys_cloud_processautomation_scheduledtrigger** — Create a scheduled Trigger. (POST /api/v2/processautomation/scheduledtriggers) Requires permission processautomation:trigger:add. Required: target, enabled, name, schedule.
- **delete_a_genesys_cloud_processautomation_scheduledtrigger_by_id** — Delete a Scheduled Trigger. (DELETE /api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}) Requires permission processautomation:trigger:delete. The id is the scheduledTriggerId. Required: id.
- **get_processautomation_scheduledtrigger_by_id** — Retrieve a single Scheduled Trigger matching id. (GET /api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}) Requires any of permissions processautomation:trigger:edit, processautomation:trigger:view. The id is the scheduledTriggerId. Required: id.
- **list_all_genesys_cloud_processautomation_scheduledtriggers** — Retrieves all scheduled triggers, optionally filtered by query parameters. (GET /api/v2/processautomation/scheduledtriggers) Requires any of permissions processautomation:trigger:edit, processautomation:trigger:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_processautomation_scheduledtrigger_by_id** — Update a Scheduled Trigger. (PUT /api/v2/processautomation/scheduledtriggers/{scheduledTriggerId}) Requires permission processautomation:trigger:edit. The id is the scheduledTriggerId. Required: id, version, enabled, target, name, schedule.
- **create_a_genesys_cloud_processautomation_trigger_test** — Test the matching of a Trigger based on provided event body. (POST /api/v2/processautomation/triggers/{triggerId}/test) Requires permission processautomation:trigger:test. Required: trigger_id.
- **create_a_genesys_cloud_processautomation_trigger_topic_test** — Test the matching of all organization Triggers on given topic using provided event body. (POST /api/v2/processautomation/triggers/topics/{topicName}/test) Requires permission processautomation:trigger:test. Required: topic_name.
- **list_all_genesys_cloud_processautomation_trigger_topics** — Get topics available for organization. (GET /api/v2/processautomation/triggers/topics) Requires any of permissions processautomation:trigger:edit, processautomation:trigger:view. Pages automatically: pass the returned next_cursor to get the next page.
- **create_a_genesys_cloud_processautomation_trigger** — Create a Trigger. (POST /api/v2/processautomation/triggers) Requires permission processautomation:trigger:add. Required: target, enabled, name, topicName.
- **delete_a_genesys_cloud_processautomation_trigger_by_id** — Delete a Trigger. (DELETE /api/v2/processautomation/triggers/{triggerId}) Requires permission processautomation:trigger:delete. The id is the triggerId. Required: id.
- **get_single_genesys_cloud_processautomation_trigger_by_id** — Retrieve a single Trigger matching id. (GET /api/v2/processautomation/triggers/{triggerId}) Requires any of permissions processautomation:trigger:edit, processautomation:trigger:view. The id is the triggerId. Required: id.
- **list_all_genesys_cloud_processautomation_triggers** — Retrieves all triggers, optionally filtered by query parameters. (GET /api/v2/processautomation/triggers) Requires any of permissions processautomation:trigger:edit, processautomation:trigger:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_processautomation_trigger_by_id** — Update a Trigger. (PUT /api/v2/processautomation/triggers/{triggerId}) Requires permission processautomation:trigger:edit. The id is the triggerId. Required: id, version, enabled, target, name, topicName.
- **list_all_genesys_cloud_quality_agent_activity** — Gets a list of Agent Activities. Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. (GET /api/v2/quality/agents/activity) Requires permission quality:evaluation:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_quality_calibration** — Create a calibration. (POST /api/v2/quality/calibrations) Requires permission quality:calibration:add. Required: conversation.
- **delete_a_genesys_cloud_quality_calibration_by_id** — Delete a calibration by id. (DELETE /api/v2/quality/calibrations/{calibrationId}) Requires permission quality:calibration:delete. The id is the calibrationId. Required: id, calibratorId.
- **get_single_genesys_cloud_quality_calibration_by_id** — Get a calibration by id. Requires either calibrator id or conversation id. (GET /api/v2/quality/calibrations/{calibrationId}) Requires permission quality:calibration:view. The id is the calibrationId. Required: id.
- **list_all_genesys_cloud_quality_calibrations** — Get the list of calibrations. NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch. (GET /api/v2/quality/calibrations) Requires permission quality:calibration:view. Pages automatically with pageNumber/pageSize. Required: calibratorId.
- **update_a_genesys_cloud_quality_calibration_by_id** — Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex. (PUT /api/v2/quality/calibrations/{calibrationId}) Requires permission quality:calibration:edit. The id is the calibrationId. Required: id.
- **get_single_genesys_cloud_quality_conversation_audit_query_by_id** — Get status of audit query execution. (GET /api/v2/quality/conversations/audits/query/{transactionId}) Requires permission audits:interactionDetails:view. The id is the transactionId. Required: id.
- **genesys_cloud_quality_conversation_audit_query_results_lookup** — Get results of audit query. (GET /api/v2/quality/conversations/audits/query/{transactionId}/results) Requires permission audits:interactionDetails:view. Required: transaction_id.
- **genesys_cloud_quality_conversation_audits_search** — Create audit query execution. (POST /api/v2/quality/conversations/audits/query) Requires permission audits:interactionDetails:view. Required: interval, filters.
- **create_a_genesys_cloud_quality_conversation_evaluation** — Create an evaluation. (POST /api/v2/quality/conversations/{conversationId}/evaluations) Requires permission quality:evaluation:add. Required: conversation_id.
- **delete_a_genesys_cloud_quality_conversation_evaluation_by_id** — Delete an evaluation. (DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}) Requires permission quality:evaluation:delete. The id is the evaluationId. Required: id, conversation_id.
- **get_single_genesys_cloud_quality_conversation_evaluation_by_id** — Get an evaluation. (GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}) Requires any of permissions quality:evaluation:view, quality:evaluation:assign, quality:evaluation:release. The id is the evaluationId. Required: id, conversation_id.
- **update_a_genesys_cloud_quality_conversation_evaluation_by_id** — Update an evaluation. The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on…. (PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}) Requires any of permissions quality:evaluation:edit, quality:evaluation:editScore, quality:evaluation:editAgentSignoff. The id is the evaluationId. Required: id, conversation_id.
- **list_all_genesys_cloud_quality_conversation_surveys** — Get the surveys for a conversation. (GET /api/v2/quality/conversations/{conversationId}/surveys) Requires permission quality:survey:view. Required: conversation_id.
- **create_a_genesys_cloud_quality_evaluation_aggregate_query_me** — Query for evaluation aggregates for the current user. (POST /api/v2/quality/evaluations/aggregates/query/me) Required: interval, metrics.
- **list_all_genesys_cloud_quality_evaluation_query** — Queries Evaluations and returns a paged list. Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. (GET /api/v2/quality/evaluations/query) Requires permission quality:evaluation:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_quality_evaluation_scoring** — Score evaluation. (POST /api/v2/quality/evaluations/scoring)
- **genesys_cloud_quality_evaluations_search** — Search evaluations based along specified criteria. Search Rules: 1. Time Range - Time Range: Max 3 months (required) 2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId 3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId 4. (POST /api/v2/quality/evaluations/search) Requires permission quality:evaluation:searchAny. Required: query, pageNumber.
- **list_all_genesys_cloud_quality_evaluator_activity** — Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly…. (GET /api/v2/quality/evaluators/activity) Requires permission quality:evaluation:view. Pages automatically with pageNumber/pageSize.
- **quality_form_evaluation_aiscoring_settings_bulk_update** — Update the AI Scoring settings of an evaluation form. (PUT /api/v2/quality/forms/evaluations/{formId}/aiscoring/settings) Requires permission quality:evaluationForm:aiScoringEdit. Required: form_id.
- **list_all_genesys_cloud_quality_form_evaluation_bulk** — Retrieve a list of evaluation forms by their ids. (GET /api/v2/quality/forms/evaluations/bulk) Requires permission quality:evaluationForm:view. Required: id.
- **list_all_genesys_cloud_quality_form_evaluation_bulk_contexts** — Retrieve a list of the latest published evaluation form versions by context ids. (GET /api/v2/quality/forms/evaluations/bulk/contexts) Requires permission quality:evaluationForm:view. Required: contextId.
- **list_all_genesys_cloud_quality_form_evaluation_versions** — Gets all the revisions for a specific evaluation. (GET /api/v2/quality/forms/evaluations/{formId}/versions) Requires permission quality:evaluationForm:view. Pages automatically with pageNumber/pageSize. Required: form_id.
- **create_a_genesys_cloud_quality_form_evaluation** — Create an evaluation form. (POST /api/v2/quality/forms/evaluations) Requires permission quality:evaluationForm:add. Required: name, questionGroups.
- **delete_a_genesys_cloud_quality_form_evaluation_by_id** — Delete an evaluation form. (DELETE /api/v2/quality/forms/evaluations/{formId}) Requires permission quality:evaluationForm:delete. The id is the formId. Required: id.
- **get_single_genesys_cloud_quality_form_evaluation_by_id** — Get an evaluation form. (GET /api/v2/quality/forms/evaluations/{formId}) Requires permission quality:evaluationForm:view. The id is the formId. Required: id.
- **list_all_genesys_cloud_quality_form_evaluations** — Get the list of evaluation forms. By default, "published" field is always returned as false for all evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form. (GET /api/v2/quality/forms/evaluations) Requires permission quality:evaluationForm:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_quality_form_evaluation_by_id** — Update an evaluation form. (PUT /api/v2/quality/forms/evaluations/{formId}) Requires permission quality:evaluationForm:edit. The id is the formId. Required: id, name, questionGroups.
- **list_all_genesys_cloud_quality_form_survey_bulk** — Retrieve a list of survey forms by their ids. (GET /api/v2/quality/forms/surveys/bulk) Requires permission quality:surveyForm:view. Required: id.
- **list_all_genesys_cloud_quality_form_survey_bulk_contexts** — Retrieve a list of the latest form versions by context ids. (GET /api/v2/quality/forms/surveys/bulk/contexts) Requires permission quality:surveyForm:view. Required: contextId.
- **list_all_genesys_cloud_quality_form_survey_versions** — Gets all the revisions for a specific survey. (GET /api/v2/quality/forms/surveys/{formId}/versions) Requires permission quality:surveyForm:view. Pages automatically with pageNumber/pageSize. Required: form_id.
- **create_a_genesys_cloud_quality_form_survey** — Create a survey form. (POST /api/v2/quality/forms/surveys) Requires permission quality:surveyForm:add. Required: name, language.
- **delete_a_genesys_cloud_quality_form_survey_by_id** — Delete a survey form. (DELETE /api/v2/quality/forms/surveys/{formId}) Requires permission quality:surveyForm:delete. The id is the formId. Required: id.
- **get_single_genesys_cloud_quality_form_survey_by_id** — Get a survey form. (GET /api/v2/quality/forms/surveys/{formId}) Requires permission quality:surveyForm:view. The id is the formId. Required: id.
- **list_all_genesys_cloud_quality_form_surveys** — Get the list of survey forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding survey form. (GET /api/v2/quality/forms/surveys) Requires permission quality:surveyForm:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_quality_form_surveys_partial_update** — Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form. (PATCH /api/v2/quality/forms/surveys/{formId}) Requires permission quality:surveyForm:disable. Required: form_id.
- **update_a_genesys_cloud_quality_form_survey_by_id** — Update a survey form. (PUT /api/v2/quality/forms/surveys/{formId}) Requires permission quality:surveyForm:edit. The id is the formId. Required: id, name, language.
- **create_a_genesys_cloud_quality_program_agentscoringrule** — Create an Agent Scoring Rule. Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form. (POST /api/v2/quality/programs/{programId}/agentscoringrules) Requires permission quality:scoringRule:add. Required: program_id, samplingType, submissionType, evaluationFormContextId, enabled.
- **delete_a_genesys_cloud_quality_program_agentscoringrule_by_id** — Delete an Agent Scoring Rule. (DELETE /api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}) Requires permission quality:scoringRule:delete. The id is the ruleId. Required: id, program_id.
- **get_single_genesys_cloud_quality_program_agentscoringrule_by_id** — Get an Agent Scoring Rule. (GET /api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}) Requires permission quality:scoringRule:view. The id is the ruleId. Required: id, program_id.
- **list_all_genesys_cloud_quality_program_agentscoringrules** — Get Agent Scoring Rules for a program. (GET /api/v2/quality/programs/{programId}/agentscoringrules) Requires permission quality:scoringRule:view. Required: program_id.
- **update_a_genesys_cloud_quality_program_agentscoringrule_by_id** — Update an Agent Scoring Rule. (PUT /api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}) Requires permission quality:scoringRule:edit. The id is the ruleId. Required: id, program_id, samplingType, submissionType, evaluationFormContextId, enabled.
- **get_quality_publishedform_evaluation_divisionview_by_id** — Get the most recent published version of an evaluation form across any division. (GET /api/v2/quality/publishedforms/evaluations/divisionviews/{evaluationFormId}) Requires permission quality:evaluationForm:search. The id is the evaluationFormId. Required: id.
- **list_all_quality_publishedform_evaluation_divisionviews** — Get the published evaluation forms across any division. (GET /api/v2/quality/publishedforms/evaluations/divisionviews) Requires permission quality:evaluationForm:search. Pages automatically with pageNumber/pageSize. Required: id.
- **create_a_genesys_cloud_quality_publishedform_evaluation** — Publish an evaluation form. (POST /api/v2/quality/publishedforms/evaluations) Requires permission quality:evaluationForm:add. Required: published, id.
- **get_single_genesys_cloud_quality_publishedform_evaluation_by_id** — Get the most recent published version of an evaluation form. (GET /api/v2/quality/publishedforms/evaluations/{formId}) Requires permission quality:evaluationForm:view. The id is the formId. Required: id.
- **list_all_genesys_cloud_quality_publishedform_evaluations** — Get the published evaluation forms. (GET /api/v2/quality/publishedforms/evaluations) Requires permission quality:evaluationForm:view. Pages automatically with pageNumber/pageSize.
- **get_quality_publishedform_survey_divisionview_by_id** — Get the most recent published version of an enabled survey form across any division. (GET /api/v2/quality/publishedforms/surveys/divisionviews/{surveyFormId}) Requires permission quality:surveyForm:search. The id is the surveyFormId. Required: id.
- **list_all_quality_publishedform_survey_divisionviews** — Get the published and enabled survey forms across any division. (GET /api/v2/quality/publishedforms/surveys/divisionviews) Requires permission quality:surveyForm:search. Pages automatically with pageNumber/pageSize. Required: id.
- **create_a_genesys_cloud_quality_publishedform_survey** — Publish a survey form. (POST /api/v2/quality/publishedforms/surveys) Requires permission quality:surveyForm:add. Required: published, id.
- **get_single_genesys_cloud_quality_publishedform_survey_by_id** — Get the most recent published version of a survey form. (GET /api/v2/quality/publishedforms/surveys/{formId}) Requires permission quality:surveyForm:view. The id is the formId. Required: id.
- **list_all_genesys_cloud_quality_publishedform_surveys** — Get the published survey forms. (GET /api/v2/quality/publishedforms/surveys) Requires permission quality:surveyForm:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_quality_survey_scoring** — Score survey. (POST /api/v2/quality/surveys/scoring)
- **create_a_genesys_cloud_quality_survey** — Create a survey for a conversation. (POST /api/v2/quality/surveys) Requires permission quality:survey:add. Required: conversationId, surveyFormContextId.
- **get_single_genesys_cloud_quality_survey_by_id** — Get a survey for a conversation. (GET /api/v2/quality/surveys/{surveyId}) Requires permission quality:survey:view. The id is the surveyId. Required: id.
- **create_a_genesys_cloud_recording_batchrequest** — Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. (POST /api/v2/recording/batchrequests) Requires any of permissions recording:recording:view, recording:recordingSegment:view, recording:snippetRecording:view, recording:screenRecording:view. Required: batchDownloadRequestList.
- **get_single_genesys_cloud_recording_batchrequest_by_id** — Get the status and results for a batch request job, only the user that submitted the job may retrieve results. (GET /api/v2/recording/batchrequests/{jobId}) The id is the jobId. Required: id.
- **recording_crossplatform_mediaretentionpolicies_bulk_delete** — Delete media retention policies. Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. (DELETE /api/v2/recording/crossplatform/mediaretentionpolicies) Requires permission recording:crossPlatformRetentionPolicy:delete. Required: ids.
- **create_recording_crossplatform_mediaretentionpolicy** — Create media retention policy. Policy does not work retroactively. (POST /api/v2/recording/crossplatform/mediaretentionpolicies) Requires permission recording:crossPlatformRetentionPolicy:add. Required: name.
- **delete_recording_crossplatform_mediaretentionpolicy_by_id** — Delete a media retention policy. (DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}) Requires permission recording:crossPlatformRetentionPolicy:delete. The id is the policyId. Required: id.
- **get_recording_crossplatform_mediaretentionpolicy_by_id** — Get a media retention policy. (GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}) Requires permission recording:crossPlatformRetentionPolicy:view. The id is the policyId. Required: id.
- **list_all_recording_crossplatform_mediaretentionpolicies** — Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint. (GET /api/v2/recording/crossplatform/mediaretentionpolicies) Requires permission recording:crossPlatformRetentionPolicy:view. Pages automatically with pageNumber/pageSize.
- **recording_crossplatform_mediaretentionpolicies_partial_update** — Patch a media retention policy. (PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}) Requires permission recording:crossPlatformRetentionPolicy:edit. Required: policy_id.
- **update_recording_crossplatform_mediaretentionpolicy_by_id** — Update a media retention policy. Policy does not work retroactively. (PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId}) Requires permission recording:crossPlatformRetentionPolicy:edit. The id is the policyId. Required: id.
- **genesys_cloud_recording_deletionprotection_bulk_update** — Apply or revoke recording protection for conversations. (PUT /api/v2/recordings/deletionprotection) Requires any of permissions recording:deletionProtection:apply, recording:deletionProtection:revoke. Required: conversationIds.
- **create_a_genesys_cloud_recording_deletionprotection** — Get a list of conversations with protected recordings. (POST /api/v2/recordings/deletionprotection) Required: conversationIds.
- **list_all_genesys_cloud_recording_job_failedrecordings** — Get IDs of recordings that the bulk job failed for. (GET /api/v2/recording/jobs/{jobId}/failedrecordings) Requires permission recording:job:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_recording_job** — Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. (POST /api/v2/recording/jobs) Requires permission recording:job:add. Required: action.
- **delete_a_genesys_cloud_recording_job_by_id** — Delete the recording bulk job. (DELETE /api/v2/recording/jobs/{jobId}) Requires permission recording:job:delete. The id is the jobId. Required: id.
- **get_single_genesys_cloud_recording_job_by_id** — Get the status of the job associated with the job id. (GET /api/v2/recording/jobs/{jobId}) Requires permission recording:job:view. The id is the jobId. Required: id.
- **list_all_genesys_cloud_recording_jobs** — Get the status of all jobs within the user's organization. (GET /api/v2/recording/jobs) Requires permission recording:job:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_recording_job_by_id** — Execute the recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention. (PUT /api/v2/recording/jobs/{jobId}) Requires permissions recording:job:edit, recording:recording:editRetention, recording:screenRecording:editRetention, recording:snippetRecording:editRetention. The id is the jobId. Required: id, state.
- **create_a_genesys_cloud_recording_keyconfiguration_validate** — Validate encryption key configurations without saving it. (POST /api/v2/recording/keyconfigurations/validate) Requires permission recording:encryptionKey:edit. Required: url, keyConfigurationType.
- **create_a_genesys_cloud_recording_keyconfiguration** — Setup configurations for encryption key creation. (POST /api/v2/recording/keyconfigurations) Requires permission recording:encryptionKey:edit. Required: url, keyConfigurationType.
- **get_single_genesys_cloud_recording_keyconfiguration_by_id** — Get the encryption key configurations. (GET /api/v2/recording/keyconfigurations/{keyConfigurationId}) Requires permission recording:encryptionKey:view. The id is the keyConfigurationId. Required: id.
- **list_all_genesys_cloud_recording_keyconfigurations** — Get a list of key configurations data. (GET /api/v2/recording/keyconfigurations) Requires permission recording:encryptionKey:view.
- **update_a_genesys_cloud_recording_keyconfiguration_by_id** — Update the encryption key configurations. (PUT /api/v2/recording/keyconfigurations/{keyConfigurationId}) Requires permission recording:encryptionKey:edit. The id is the keyConfigurationId. Required: id, url, keyConfigurationType.
- **create_a_genesys_cloud_recording_localkey** — create a local key management recording key. (POST /api/v2/recording/localkeys) Requires permission recording:encryptionKey:edit. Required: configId, publicKey, keypairId.
- **genesys_cloud_recording_mediaretentionpolicies_bulk_delete** — Delete media retention policies. Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param. (DELETE /api/v2/recording/mediaretentionpolicies) Requires permission recording:retentionPolicy:delete. Required: ids.
- **create_a_genesys_cloud_recording_mediaretentionpolicy** — Create media retention policy. Policy does not work retroactively. (POST /api/v2/recording/mediaretentionpolicies) Requires permission recording:retentionPolicy:add. Required: name.
- **delete_a_genesys_cloud_recording_mediaretentionpolicy_by_id** — Delete a media retention policy. (DELETE /api/v2/recording/mediaretentionpolicies/{policyId}) Requires permission recording:retentionPolicy:delete. The id is the policyId. Required: id.
- **get_single_genesys_cloud_recording_mediaretentionpolicy_by_id** — Get a media retention policy. (GET /api/v2/recording/mediaretentionpolicies/{policyId}) Requires permission recording:retentionPolicy:view. The id is the policyId. Required: id.
- **list_all_genesys_cloud_recording_mediaretentionpolicies** — Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint. (GET /api/v2/recording/mediaretentionpolicies) Requires permission recording:retentionPolicy:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_recording_mediaretentionpolicies_partial_update** — Patch a media retention policy. (PATCH /api/v2/recording/mediaretentionpolicies/{policyId}) Requires permission recording:retentionPolicy:edit. Required: policy_id.
- **update_a_genesys_cloud_recording_mediaretentionpolicy_by_id** — Update a media retention policy. Policy does not work retroactively. In the conditions.forUsers section, each user object can include the 'id' field containing the user's unique identifier. Example: [{"id":" "}]. (PUT /api/v2/recording/mediaretentionpolicies/{policyId}) Requires permission recording:retentionPolicy:edit. The id is the policyId. Required: id.
- **recording_recordingkey_rotationschedule_bulk_update** — Update key rotation schedule. (PUT /api/v2/recording/recordingkeys/rotationschedule) Requires permission recording:encryptionKey:edit. Required: period.
- **genesys_cloud_recording_recordingkey_rotationschedule_lookup** — Get key rotation schedule. (GET /api/v2/recording/recordingkeys/rotationschedule) Requires permission recording:encryptionKey:view.
- **create_a_genesys_cloud_recording_recordingkey** — Create encryption key. (POST /api/v2/recording/recordingkeys) Requires permission recording:encryptionKey:edit.
- **list_all_genesys_cloud_recording_recordingkeys** — Get encryption key list. (GET /api/v2/recording/recordingkeys) Requires permission recording:encryptionKey:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_recording_retention_query** — Query for recording retention data. (GET /api/v2/recordings/retention/query) Requires permission recording:recording:view. Pages automatically: pass the returned next_cursor to get the next page. Required: retentionThresholdDays.
- **create_a_genesys_cloud_recording_screensession_acknowledge** — Acknowledge a screen recording. (POST /api/v2/recordings/screensessions/acknowledge)
- **genesys_cloud_recording_screensession_details_lookup** — Retrieves an object containing the total number of concurrent active screen recordings. (GET /api/v2/recordings/screensessions/details) Requires permission recording:screenRecording:view.
- **create_a_genesys_cloud_recording_screensession_metadatum** — Provide meta-data a screen recording. (POST /api/v2/recordings/screensessions/metadata)
- **genesys_cloud_recording_settings_bulk_update** — Update the Recording Settings for the Organization. (PUT /api/v2/recording/settings) Requires any of permissions recording:settings:editScreenRecordings, recording:settings:editRegionalStorage, recording:settings:editUrlExpiration, recording:settings:editConferenceRecording ….
- **genesys_cloud_recording_settings_lookup** — Get the Recording Settings for the Organization. (GET /api/v2/recording/settings)
- **create_a_genesys_cloud_recording_upload_report** — Creates a recording upload status report. (POST /api/v2/recording/uploads/reports) Requires permission recording:uploadReport:add. Required: dateSince.
- **get_single_genesys_cloud_recording_upload_report_by_id** — Get the status of a recording upload status report. (GET /api/v2/recording/uploads/reports/{reportId}) Requires permission recording:uploadReport:view. The id is the reportId. Required: id.
- **create_a_genesys_cloud_responsemanagement_library** — Create a response library. (POST /api/v2/responsemanagement/libraries) Requires permission responses:library:add. Required: name.
- **delete_a_genesys_cloud_responsemanagement_library_by_id** — Delete an existing response library. This will remove any responses associated with the library. (DELETE /api/v2/responsemanagement/libraries/{libraryId}) Requires permission responses:library:delete. The id is the libraryId. Required: id.
- **get_single_genesys_cloud_responsemanagement_library_by_id** — Get details about an existing response library. (GET /api/v2/responsemanagement/libraries/{libraryId}) Requires permission responses:library:view. The id is the libraryId. Required: id.
- **list_all_genesys_cloud_responsemanagement_libraries** — Gets a list of existing response libraries. (GET /api/v2/responsemanagement/libraries) Requires permission responses:library:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_responsemanagement_libraries_search** — Query libraries using criteria. Users can set DivisionId parameter as '' to fetch libraries that aren't associated with any divisions. (POST /api/v2/responsemanagement/libraries/query) Requires permission responses:library:view. Required: query.
- **update_a_genesys_cloud_responsemanagement_library_by_id** — Update an existing response library. Fields that can be updated: name. The most recent version is required for updates. (PUT /api/v2/responsemanagement/libraries/{libraryId}) Requires permission responses:library:edit. The id is the libraryId. Required: id, name.
- **create_a_genesys_cloud_responsemanagement_library_bulk** — Get response libraries. (POST /api/v2/responsemanagement/libraries/bulk) Requires permission responses:library:view. Required: libraryIds.
- **get_responsemanagement_library_divisionview_by_id** — Get details about an existing response library. (GET /api/v2/responsemanagement/libraries/divisionviews/{libraryId}) Requires permission responses:library:search. The id is the libraryId. Required: id.
- **list_all_genesys_cloud_responsemanagement_library_divisionviews** — Gets a list of existing response libraries. (GET /api/v2/responsemanagement/libraries/divisionviews) Requires permission responses:library:search. Pages automatically with pageNumber/pageSize.
- **get_responsemanagement_response_divisionview_by_id** — Get details about an existing response. (GET /api/v2/responsemanagement/responses/divisionviews/{responseId}) Requires permission responses:response:search. The id is the responseId. Required: id.
- **genesys_cloud_responsemanagement_response_divisionviews_search** — Query responses. (POST /api/v2/responsemanagement/responses/divisionviews/query) Requires permission responses:response:search.
- **create_a_genesys_cloud_responsemanagement_responseasset_bulk** — Get response assets. (POST /api/v2/responsemanagement/responseassets/bulk) Requires permission responseAssets:asset:view. Required: assetIds.
- **get_responsemanagement_responseasset_status_by_id** — Get response asset upload status. (GET /api/v2/responsemanagement/responseassets/status/{statusId}) Requires permission responseAssets:asset:view. The id is the statusId. Required: id.
- **create_a_genesys_cloud_responsemanagement_responseasset_upload** — Creates pre-signed url for uploading response asset. (POST /api/v2/responsemanagement/responseassets/uploads) Requires permission responseAssets:asset:add. Required: name.
- **delete_a_genesys_cloud_responsemanagement_responseasset_by_id** — Delete response asset. (DELETE /api/v2/responsemanagement/responseassets/{responseAssetId}) Requires permission responseAssets:asset:delete. The id is the responseAssetId. Required: id.
- **get_single_genesys_cloud_responsemanagement_responseasset_by_id** — Get response asset information. (GET /api/v2/responsemanagement/responseassets/{responseAssetId}) Requires permission responseAssets:asset:view. The id is the responseAssetId. Required: id.
- **genesys_cloud_responsemanagement_responseassets_search** — Search response assets. (POST /api/v2/responsemanagement/responseassets/search) Requires permission responseAssets:asset:view. Required: query.
- **update_a_genesys_cloud_responsemanagement_responseasset_by_id** — Update response asset. (PUT /api/v2/responsemanagement/responseassets/{responseAssetId}) Requires permission responseAssets:asset:edit. The id is the responseAssetId. Required: id, name.
- **create_a_genesys_cloud_responsemanagement_response** — Create a response. (POST /api/v2/responsemanagement/responses) Requires permission responses:response:add. Required: libraries.
- **delete_a_genesys_cloud_responsemanagement_response_by_id** — Delete an existing response. This will remove the response from any libraries associated with it. (DELETE /api/v2/responsemanagement/responses/{responseId}) Requires permission responses:response:delete. The id is the responseId. Required: id.
- **get_single_genesys_cloud_responsemanagement_response_by_id** — Get details about an existing response. (GET /api/v2/responsemanagement/responses/{responseId}) Requires permission responses:response:view. The id is the responseId. Required: id.
- **list_all_genesys_cloud_responsemanagement_responses** — Gets a list of existing responses. (GET /api/v2/responsemanagement/responses) Requires permission responses:response:view. Pages automatically with pageNumber/pageSize. Required: libraryId.
- **genesys_cloud_responsemanagement_responses_search** — Query responses. (POST /api/v2/responsemanagement/responses/query) Requires permission responses:response:view.
- **update_a_genesys_cloud_responsemanagement_response_by_id** — Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates. (PUT /api/v2/responsemanagement/responses/{responseId}) Requires permission responses:response:edit. The id is the responseId. Required: id, libraries.
- **create_a_genesys_cloud_routing_assessment_job** — Create a benefit assessment job. Queues with Benefit Assessment results less than 7 days old are skipped. If every queue in the requested divisions has recent results, the request is rejected. (POST /api/v2/routing/assessments/jobs) Requires permission routing:assessment:add.
- **get_single_genesys_cloud_routing_assessment_job_by_id** — Retrieve a single benefit assessments job. (GET /api/v2/routing/assessments/jobs/{jobId}) Requires permission routing:assessment:view. The id is the jobId. Required: id.
- **list_all_genesys_cloud_routing_assessment_jobs** — Retrieve all benefit assessment jobs. (GET /api/v2/routing/assessments/jobs) Requires permission routing:queue:view.
- **create_a_genesys_cloud_routing_assessment** — Create a benefit assessment. (POST /api/v2/routing/assessments) Requires permissions routing:assessment:add, routing:queue:view. Required: queueIds.
- **delete_a_genesys_cloud_routing_assessment_by_id** — Delete single benefit assessment. (DELETE /api/v2/routing/assessments/{assessmentId}) Requires permission routing:assessment:delete. The id is the assessmentId. Required: id.
- **get_single_genesys_cloud_routing_assessment_by_id** — Retrieve a single benefit assessment. (GET /api/v2/routing/assessments/{assessmentId}) Requires permission routing:assessment:view. The id is the assessmentId. Required: id.
- **list_all_genesys_cloud_routing_assessments** — Retrieve all benefit assessments. (GET /api/v2/routing/assessments) Requires any of permissions routing:queue:view, routing:assessment:view. Pages automatically: pass the returned next_cursor to get the next page.
- **list_all_genesys_cloud_routing_availablemediatypes** — Get available media types. (GET /api/v2/routing/availablemediatypes)
- **update_a_genesys_cloud_routing_conversation_by_id** — Update attributes of an in-queue conversation. Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, skillExpression, languageId, and priority. (PATCH /api/v2/routing/conversations/{conversationId}) Requires permission routing:conversation:edit. The id is the conversationId. Required: id.
- **routing_directroutingbackup_settings_me_bulk_delete** — Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. (DELETE /api/v2/routing/directroutingbackup/settings/me) Requires permission routing:directRoutingBackup:selfDelete.
- **routing_directroutingbackup_settings_me_bulk_update** — Update the user's Direct Routing Backup settings. (PUT /api/v2/routing/directroutingbackup/settings/me) Requires permission routing:directRoutingBackup:selfEdit.
- **genesys_cloud_routing_directroutingbackup_settings_me_lookup** — Get the user's Direct Routing Backup settings. (GET /api/v2/routing/directroutingbackup/settings/me) Requires permission routing:directRoutingBackup:selfView.
- **create_a_genesys_cloud_routing_email_domain_dkim** — Restart domain dkim. (POST /api/v2/routing/email/domains/{domainId}/dkim) Requires permission routing:email:manage. Required: domain_id.
- **genesys_cloud_routing_email_domain_dkim_lookup** — Get domain dkim settings. (GET /api/v2/routing/email/domains/{domainId}/dkim) Requires permission routing:email:manage. Required: domain_id.
- **create_a_genesys_cloud_routing_email_domain_mailfrom** — Set domain mail from settings. (POST /api/v2/routing/email/domains/{domainId}/mailfrom) Requires permission routing:email:manage. Required: domain_id, mailFromDomain.
- **genesys_cloud_routing_email_domain_mailfrom_lookup** — Get domain mail from settings. (GET /api/v2/routing/email/domains/{domainId}/mailfrom) Requires permission routing:email:manage. Required: domain_id.
- **routing_email_domain_route_identityresolution_bulk_update** — Update identity resolution settings for a route. (PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution) Requires permissions routing:email:manage, routing:identityResolutionEmail:edit. Required: domain_name, route_id, resolveIdentities.
- **routing_email_domain_route_identityresolution_lookup** — Get a route identity resolution setting. (GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution) Requires permissions routing:email:manage, routing:identityResolutionEmail:view. Required: domain_name, route_id.
- **create_a_genesys_cloud_routing_email_domain_route** — Create a route. (POST /api/v2/routing/email/domains/{domainName}/routes) Requires permission routing:email:manage. Required: domain_name, pattern, fromName.
- **delete_a_genesys_cloud_routing_email_domain_route_by_id** — Delete a route. (DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}) Requires permission routing:email:manage. The id is the routeId. Required: id, domain_name.
- **get_single_genesys_cloud_routing_email_domain_route_by_id** — Get a route. (GET /api/v2/routing/email/domains/{domainName}/routes/{routeId}) Requires any of permissions routing:email:view, routing:email:manage. The id is the routeId. Required: id, domain_name.
- **list_all_genesys_cloud_routing_email_domain_routes** — Get routes. (GET /api/v2/routing/email/domains/{domainName}/routes) Requires any of permissions routing:email:view, routing:email:manage. Pages automatically with pageNumber/pageSize. Required: domain_name.
- **update_a_genesys_cloud_routing_email_domain_route_by_id** — Update a route. (PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}) Requires permission routing:email:manage. The id is the routeId. Required: id, domain_name, pattern, fromName.
- **create_a_genesys_cloud_routing_email_domain_testconnection** — Tests the custom SMTP server integration connection set on this ACD domain. The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server used by the ACD domain. If the body is specified, there will be an attempt to send an email message to the server. (POST /api/v2/routing/email/domains/{domainId}/testconnection) Requires permission routing:email:manage. Required: domain_id, to, from, textBody.
- **genesys_cloud_routing_email_domain_validate_bulk_partial_update** — Validate domain settings. (PATCH /api/v2/routing/email/domains/{domainId}/validate) Requires permission routing:email:manage. Required: domain_id.
- **create_a_genesys_cloud_routing_email_domain_verification** — Restart domain verification. (POST /api/v2/routing/email/domains/{domainId}/verification) Requires permission routing:email:manage. Required: domain_id.
- **genesys_cloud_routing_email_domain_verification_lookup** — Get domain verification settings. (GET /api/v2/routing/email/domains/{domainId}/verification) Requires permission routing:email:manage. Required: domain_id.
- **create_a_genesys_cloud_routing_email_domain** — Create a domain. (POST /api/v2/routing/email/domains) Requires permission routing:email:manage. Required: id.
- **delete_a_genesys_cloud_routing_email_domain_by_id** — Delete a domain. (DELETE /api/v2/routing/email/domains/{domainId}) Requires permission routing:email:manage. The id is the domainId. Required: id.
- **get_single_genesys_cloud_routing_email_domain_by_id** — Get domain. (GET /api/v2/routing/email/domains/{domainId}) Requires any of permissions routing:email:manage, routing:email:view. The id is the domainId. Required: id.
- **list_all_genesys_cloud_routing_email_domains** — Get domains. (GET /api/v2/routing/email/domains) Requires permission routing:email:manage. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_email_domain_by_id** — Update domain settings. (PATCH /api/v2/routing/email/domains/{domainId}) Requires permission routing:email:manage. The id is the domainId. Required: id.
- **routing_email_outbound_domain_activation_bulk_update** — Request an activation status (cname + dkim) update of an outbound domain. (PUT /api/v2/routing/email/outbound/domains/{domainId}/activation) Requires permission routing:email:manage. Required: domain_id.
- **genesys_cloud_routing_email_outbound_domain_activation_lookup** — Get activation status (cname + dkim) of an outbound domain. (GET /api/v2/routing/email/outbound/domains/{domainId}/activation) Requires permission routing:email:manage. Required: domain_id.
- **create_a_genesys_cloud_routing_email_outbound_domain_simulated** — Create a simulated domain. (POST /api/v2/routing/email/outbound/domains/simulated) Requires permission routing:email:manage. Required: id, name.
- **create_routing_email_outbound_domain_testconnection** — Tests the custom SMTP server integration connection set on this outbound domain. The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server for the outbound domain. If the body is specified, there will be an attempt to send an email message to the server. (POST /api/v2/routing/email/outbound/domains/{domainId}/testconnection) Requires permission routing:email:manage. Required: domain_id, to, from, textBody.
- **create_a_genesys_cloud_routing_email_outbound_domain** — Create a domain. (POST /api/v2/routing/email/outbound/domains) Requires permission routing:email:manage. Required: id, name.
- **delete_a_genesys_cloud_routing_email_outbound_domain_by_id** — Delete an outbound domain. (DELETE /api/v2/routing/email/outbound/domains/{domainId}) Requires permission routing:email:manage. The id is the domainId. Required: id.
- **get_single_genesys_cloud_routing_email_outbound_domain_by_id** — Get domain. (GET /api/v2/routing/email/outbound/domains/{domainId}) Requires any of permissions routing:email:manage, routing:email:view. The id is the domainId. Required: id.
- **list_all_genesys_cloud_routing_email_outbound_domains** — Get outbound domains. (GET /api/v2/routing/email/outbound/domains) Requires permission routing:email:manage. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_email_outbound_domain_by_id** — Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP). (PATCH /api/v2/routing/email/outbound/domains/{domainId}) Requires permission routing:email:manage. The id is the domainId. Required: id.
- **create_a_genesys_cloud_routing_email_setting** — Create a new email setting. Used to define various settings, that can then be associated with email domains. (POST /api/v2/routing/email/setting) Requires permission email:settings:add. Required: name.
- **delete_a_genesys_cloud_routing_email_setting_by_id** — Delete an email setting. Removes the email setting and its associated settings. (DELETE /api/v2/routing/email/setting/{emailSettingId}) Requires permission email:settings:delete. The id is the emailSettingId. Required: id.
- **get_single_genesys_cloud_routing_email_setting_by_id** — Get email setting. Returns the specified email setting that defines settings for email. (GET /api/v2/routing/email/setting/{emailSettingId}) Requires permission email:settings:view. The id is the emailSettingId. Required: id.
- **list_all_genesys_cloud_routing_email_setting** — Get a paged list of email routing settings. (GET /api/v2/routing/email/setting) Requires permission email:settings:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_email_setting_by_id** — Update an email setting. Modifies the settings for email setting. (PATCH /api/v2/routing/email/setting/{emailSettingId}) Requires permission email:settings:edit. The id is the emailSettingId. Required: id.
- **genesys_cloud_routing_email_setup_lookup** — Get email setup. (GET /api/v2/routing/email/setup) Requires permission routing:email:manage.
- **create_a_genesys_cloud_routing_language** — Create Language. (POST /api/v2/routing/languages) Requires permission routing:skill:manage. Required: name.
- **delete_a_genesys_cloud_routing_language_by_id** — Delete a routing language. (DELETE /api/v2/routing/languages/{languageId}) Requires permission routing:skill:manage. The id is the languageId. Required: id.
- **get_single_genesys_cloud_routing_language_by_id** — Get a routing language. (GET /api/v2/routing/languages/{languageId}) The id is the languageId. Required: id.
- **list_all_genesys_cloud_routing_languages** — Get the list of supported languages. (GET /api/v2/routing/languages) Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_routing_message_recipient_by_id** — Get a recipient. (GET /api/v2/routing/message/recipients/{recipientId}) Requires permission routing:message:manage. The id is the recipientId. Required: id.
- **list_all_genesys_cloud_routing_message_recipients** — Get recipients. (GET /api/v2/routing/message/recipients) Requires permission routing:message:manage. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_message_recipient_by_id** — Update a recipient. (PUT /api/v2/routing/message/recipients/{recipientId}) Requires permission routing:message:manage. The id is the recipientId. Required: id.
- **create_a_genesys_cloud_routing_predictor_keyperformanceindicator** — Create a custom Key Performance Indicator. (POST /api/v2/routing/predictors/keyperformanceindicators) Requires permission routing:keyPerformanceIndicator:add. Required: name, kpiType, source.
- **delete_routing_predictor_keyperformanceindicator_by_id** — Delete a custom Key Performance Indicator. (DELETE /api/v2/routing/predictors/keyperformanceindicators/{kpiId}) Requires permission routing:keyPerformanceIndicator:delete. The id is the kpiId. Required: id.
- **get_routing_predictor_keyperformanceindicator_by_id** — Retrieve a single Key Performance Indicator. (GET /api/v2/routing/predictors/keyperformanceindicators/{kpiId}) Requires permission routing:keyPerformanceIndicator:view. The id is the kpiId. Required: id.
- **list_all_routing_predictor_keyperformanceindicators** — Get a list of Key Performance Indicators. (GET /api/v2/routing/predictors/keyperformanceindicators) Requires permission routing:keyPerformanceIndicator:view.
- **update_routing_predictor_keyperformanceindicator_by_id** — Update a custom Key Performance Indicator. (PATCH /api/v2/routing/predictors/keyperformanceindicators/{kpiId}) Requires permission routing:keyPerformanceIndicator:edit. The id is the kpiId. Required: id.
- **list_all_routing_predictor_keyperformanceindicatortypes** — Get a list of Key Performance Indicators Types available. (GET /api/v2/routing/predictors/keyperformanceindicatortypes) Requires permission routing:keyPerformanceIndicator:view.
- **list_all_genesys_cloud_routing_predictor_model_features** — Retrieve Predictor Model Features. (GET /api/v2/routing/predictors/{predictorId}/models/{modelId}/features) Requires permission routing:predictorModelFeature:view. Required: predictor_id, model_id.
- **genesys_cloud_routing_predictor_models_lookup** — Retrieve Predictor Models and Top Features. (GET /api/v2/routing/predictors/{predictorId}/models) Requires permission routing:predictorModel:view. Required: predictor_id.
- **create_a_genesys_cloud_routing_predictor** — Create a predictor. (POST /api/v2/routing/predictors) Requires permissions routing:predictor:add, routing:queue:edit. Required: queueIds, kpi.
- **delete_a_genesys_cloud_routing_predictor_by_id** — Delete single predictor. (DELETE /api/v2/routing/predictors/{predictorId}) Requires permissions routing:predictor:delete, routing:queue:edit. The id is the predictorId. Required: id.
- **get_single_genesys_cloud_routing_predictor_by_id** — Retrieve a single predictor. (GET /api/v2/routing/predictors/{predictorId}) Requires permission routing:predictor:view. The id is the predictorId. Required: id.
- **list_all_genesys_cloud_routing_predictors** — Retrieve all predictors. (GET /api/v2/routing/predictors) Requires any of permissions routing:predictor:view, routing:queue:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_routing_predictor_by_id** — Update single predictor. (PATCH /api/v2/routing/predictors/{predictorId}) Requires permissions routing:predictor:edit, routing:queue:edit. The id is the predictorId. Required: id.
- **genesys_cloud_routing_queue_assistant_lookup** — Get an assistant associated with a queue. (GET /api/v2/routing/queues/{queueId}/assistant) Requires permission assistants:queue:view. Required: queue_id.
- **get_single_genesys_cloud_routing_queue_comparisonperiod_by_id** — Get a Comparison Period. (GET /api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}) Requires permissions routing:comparisonPeriod:view, routing:queue:view. The id is the comparisonPeriodId. Required: id, queue_id.
- **list_all_genesys_cloud_routing_queue_comparisonperiods** — Get list of comparison periods. (GET /api/v2/routing/queues/{queueId}/comparisonperiods) Requires permissions routing:comparisonPeriod:view, routing:queue:view. Required: queue_id.
- **list_all_genesys_cloud_routing_queue_divisionview_all** — Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization. (GET /api/v2/routing/queues/divisionviews/all) Requires permission routing:queue:search. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_routing_queue_divisionviews** — Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s). (GET /api/v2/routing/queues/divisionviews) Requires permission routing:queue:search. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_routing_queue_estimatedwaittime** — Get Estimated Wait Time. (GET /api/v2/routing/queues/{queueId}/estimatedwaittime) Requires permission routing:queue:view. Required: queue_id.
- **genesys_cloud_routing_queue_identityresolution_bulk_update** — Update Queue IdentityResolution Settings. (PUT /api/v2/routing/queues/{queueId}/identityresolution) Requires permissions routing:queue:edit, queue:identityResolution:edit. Required: queue_id.
- **genesys_cloud_routing_queue_identityresolution_lookup** — Get Queue IdentityResolution Settings. (GET /api/v2/routing/queues/{queueId}/identityresolution) Requires permissions routing:queue:view, queue:identityResolution:view. Required: queue_id.
- **list_all_genesys_cloud_routing_queue_me** — Get a paged listing of queues the user is a member of. (GET /api/v2/routing/queues/me) Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_routing_queue_mediatype_estimatedwaittime** — Get Estimated Wait Time. (GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime) Requires permission routing:queue:view. Required: queue_id, media_type.
- **genesys_cloud_routing_queue_members_bulk_partial_update** — Join or unjoin a set of up to 100 users for a queue. Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. (PATCH /api/v2/routing/queues/{queueId}/members) Requires any of permissions routing:queue:edit, routing:queueMember:manage. Required: queue_id.
- **create_a_genesys_cloud_routing_queue_member** — Bulk add or delete up to 100 queue members. (POST /api/v2/routing/queues/{queueId}/members) Requires any of permissions routing:queue:edit, routing:queueMember:manage. Required: queue_id.
- **delete_a_genesys_cloud_routing_queue_member_by_id** — Delete a queue member. (DELETE /api/v2/routing/queues/{queueId}/members/{memberId}) Requires any of permissions routing:queue:edit, routing:queueMember:manage. The id is the memberId. Required: id, queue_id.
- **list_all_genesys_cloud_routing_queue_members** — Get the members of this queue. (GET /api/v2/routing/queues/{queueId}/members) Requires any of permissions routing:queue:view, routing:queue:edit, routing:queue:readonly, routing:queueMember:manage. Pages automatically with pageNumber/pageSize. Required: queue_id.
- **update_a_genesys_cloud_routing_queue_member_by_id** — Update the ring number OR joined status for a queue member. (PATCH /api/v2/routing/queues/{queueId}/members/{memberId}) Requires any of permissions routing:queue:edit, routing:queueMember:manage. The id is the memberId. Required: id, queue_id.
- **create_a_genesys_cloud_routing_queue_wrapupcode** — Add up to 100 wrap-up codes to a queue. (POST /api/v2/routing/queues/{queueId}/wrapupcodes) Requires permission routing:queue:edit. Required: queue_id.
- **delete_a_genesys_cloud_routing_queue_wrapupcode_by_id** — Delete a wrap-up code from a queue. (DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}) Requires permission routing:queue:edit. The id is the codeId. Required: id, queue_id.
- **list_all_genesys_cloud_routing_queue_wrapupcodes** — Get the wrap-up codes for a queue. (GET /api/v2/routing/queues/{queueId}/wrapupcodes) Requires permission routing:queue:view. Pages automatically with pageNumber/pageSize. Required: queue_id.
- **create_a_genesys_cloud_routing_queue** — Create a queue. (POST /api/v2/routing/queues) Requires permission routing:queue:add. Required: name.
- **delete_a_genesys_cloud_routing_queue_by_id** — Delete a queue. (DELETE /api/v2/routing/queues/{queueId}) Requires permission routing:queue:delete. The id is the queueId. Required: id.
- **get_single_genesys_cloud_routing_queue_by_id** — Get details about this queue. (GET /api/v2/routing/queues/{queueId}) Requires permission routing:queue:view. The id is the queueId. Required: id.
- **list_all_genesys_cloud_routing_queues** — Get list of queues. (GET /api/v2/routing/queues) Requires permission routing:queue:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_queue_by_id** — Update a queue. (PUT /api/v2/routing/queues/{queueId}) Requires permission routing:queue:edit. The id is the queueId. Required: id, name.
- **genesys_cloud_routing_settings_bulk_delete** — Delete an organization's routing settings. (DELETE /api/v2/routing/settings) Requires permission routing:settings:edit.
- **genesys_cloud_routing_settings_bulk_update** — Update an organization's routing settings. (PUT /api/v2/routing/settings) Requires permission routing:settings:edit.
- **genesys_cloud_routing_settings_lookup** — Get an organization's routing settings. (GET /api/v2/routing/settings)
- **genesys_cloud_routing_settings_contactcenter_bulk_partial_update** — Update Contact Center Settings. (PATCH /api/v2/routing/settings/contactcenter) Requires permission routing:settings:edit.
- **genesys_cloud_routing_settings_contactcenter_lookup** — Get Contact Center Settings. (GET /api/v2/routing/settings/contactcenter)
- **genesys_cloud_routing_settings_transcription_bulk_partial_update** — Patch Transcription Settings. (PATCH /api/v2/routing/settings/transcription) Requires permission routing:transcriptionSettings:edit.
- **genesys_cloud_routing_settings_transcription_bulk_update** — Update Transcription Settings. (PUT /api/v2/routing/settings/transcription) Requires permission routing:transcriptionSettings:edit. Required: transcription, transcriptionConfidenceThreshold.
- **genesys_cloud_routing_settings_transcription_lookup** — Get Transcription Settings. (GET /api/v2/routing/settings/transcription) Requires permission routing:transcriptionSettings:view.
- **get_single_genesys_cloud_routing_skillexpression_queue_by_id** — Get skill expressions associated with a queue. (GET /api/v2/routing/skillexpressions/queue/{queueId}) Requires permission routing:skillExpressions:view. The id is the queueId. Required: id.
- **create_a_genesys_cloud_routing_skillexpression_validate** — Validate and normalize a skill expression. (POST /api/v2/routing/skillexpressions/validate) Requires permission routing:skillExpressions:add. Required: expression.
- **genesys_cloud_routing_skillexpressions_bulk_delete** — Archive a set of skill expressions to remove them from the set of active expressions. (DELETE /api/v2/routing/skillexpressions) Requires permission routing:skillExpressions:delete.
- **delete_a_genesys_cloud_routing_skillexpression_by_id** — Archive a skill expression to remove it from the set of active expressions. (DELETE /api/v2/routing/skillexpressions/{expressionId}) Requires permission routing:skillExpressions:delete. The id is the expressionId. Required: id.
- **get_single_genesys_cloud_routing_skillexpression_by_id** — Get a skill expression by ID. (GET /api/v2/routing/skillexpressions/{expressionId}) Requires permission routing:skillExpressions:view. The id is the expressionId. Required: id.
- **list_all_genesys_cloud_routing_skillexpressions** — Get skill expressions. (GET /api/v2/routing/skillexpressions) Requires permission routing:skillExpressions:view.
- **create_a_genesys_cloud_routing_skillgroup_member_division** — Add or remove member divisions for this skill group. (POST /api/v2/routing/skillgroups/{skillGroupId}/members/divisions) Requires permission routing:skillGroup:add. Required: skill_group_id.
- **list_all_genesys_cloud_routing_skillgroup_member_divisions** — Get list of member divisions for this skill group. (GET /api/v2/routing/skillgroups/{skillGroupId}/members/divisions) Requires permission routing:skillGroup:view. Required: skill_group_id.
- **list_all_genesys_cloud_routing_skillgroup_members** — Get skill group members. (GET /api/v2/routing/skillgroups/{skillGroupId}/members) Requires permission routing:skillGroup:view. Pages automatically: pass the returned next_cursor to get the next page. Required: skill_group_id.
- **create_a_genesys_cloud_routing_skillgroup** — Create a skill group. (POST /api/v2/routing/skillgroups) Requires permission routing:skillGroup:add. Required: name, skillConditions.
- **delete_a_genesys_cloud_routing_skillgroup_by_id** — Remove skill group definition. (DELETE /api/v2/routing/skillgroups/{skillGroupId}) Requires permission routing:skillGroup:delete. The id is the skillGroupId. Required: id.
- **get_single_genesys_cloud_routing_skillgroup_by_id** — Get skill group. (GET /api/v2/routing/skillgroups/{skillGroupId}) Requires permission routing:skillGroup:view. The id is the skillGroupId. Required: id.
- **list_all_genesys_cloud_routing_skillgroups** — Get skill group listing. (GET /api/v2/routing/skillgroups) Requires permission routing:skillGroup:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_routing_skillgroup_by_id** — Update skill group definition. (PATCH /api/v2/routing/skillgroups/{skillGroupId}) Requires permission routing:skillGroup:edit. The id is the skillGroupId. Required: id, name, skillConditions.
- **create_a_genesys_cloud_routing_skill** — Create Skill. (POST /api/v2/routing/skills) Requires any of permissions routing:skill:manage, routing:skill:create. Required: name.
- **delete_a_genesys_cloud_routing_skill_by_id** — Delete Routing Skill. (DELETE /api/v2/routing/skills/{skillId}) Requires any of permissions routing:skill:manage, routing:skill:delete. The id is the skillId. Required: id.
- **get_single_genesys_cloud_routing_skill_by_id** — Get Routing Skill. (GET /api/v2/routing/skills/{skillId}) Requires permission routing:skill:view. The id is the skillId. Required: id.
- **list_all_genesys_cloud_routing_skills** — Get the list of routing skills. View permission enforcement only applies to skills assigned to a division. (GET /api/v2/routing/skills) Requires permission routing:skill:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_skill_by_id** — Update Routing Skill Division. (PATCH /api/v2/routing/skills/{skillId}) Requires permission routing:skill:update. The id is the skillId. Required: id.
- **create_a_genesys_cloud_routing_sms_address** — Provision an Address for SMS. (POST /api/v2/routing/sms/addresses) Requires permission sms:phoneNumber:add. Required: name, street, city, region, postalCode, countryCode.
- **delete_a_genesys_cloud_routing_sms_address_by_id** — Delete an Address by Id for SMS. (DELETE /api/v2/routing/sms/addresses/{addressId}) Requires permission sms:phoneNumber:delete. The id is the addressId. Required: id.
- **get_single_genesys_cloud_routing_sms_address_by_id** — Get an Address by Id for SMS. (GET /api/v2/routing/sms/addresses/{addressId}) Requires permission sms:phoneNumber:view. The id is the addressId. Required: id.
- **list_all_genesys_cloud_routing_sms_addresses** — Get a list of Addresses for SMS. (GET /api/v2/routing/sms/addresses) Requires permission sms:phoneNumber:view. Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_routing_sms_availablephonenumbers** — Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request. (GET /api/v2/routing/sms/availablephonenumbers) Requires permission sms:phoneNumber:add. Required: countryCode, phoneNumberType.
- **get_routing_sms_identityresolution_phonenumber_by_id** — Get a SMS identity resolution settings. (GET /api/v2/routing/sms/identityresolution/phonenumbers/{addressId}) Requires permissions sms:phoneNumber:view, sms:identityResolution:view. The id is the addressId. Required: id.
- **update_routing_sms_identityresolution_phonenumber_by_id** — Update an SMS identity resolution settings. (PUT /api/v2/routing/sms/identityresolution/phonenumbers/{addressId}) Requires permissions sms:phoneNumber:edit, sms:identityResolution:edit. The id is the addressId. Required: id, resolveIdentities.
- **create_a_genesys_cloud_routing_sms_phonenumber_import** — Imports a phone number for SMS. (POST /api/v2/routing/sms/phonenumbers/import) Requires permission sms:phoneNumber:byoImport. Required: phoneNumber, phoneNumberType, countryCode, integrationId.
- **create_a_genesys_cloud_routing_sms_phonenumber** — Provision a phone number for SMS. When provisioning an MMS-capable phone number, if no supported content profile is specified in the request, the system automatically assigns the "SMS Default" profile. (POST /api/v2/routing/sms/phonenumbers) Requires permission sms:phoneNumber:add. Required: phoneNumber, phoneNumberType, countryCode.
- **delete_a_genesys_cloud_routing_sms_phonenumber_by_id** — Delete a phone number provisioned for SMS. (DELETE /api/v2/routing/sms/phonenumbers/{phoneNumberId}) Requires permission sms:phoneNumber:delete. The id is the phoneNumberId. Required: id.
- **get_single_genesys_cloud_routing_sms_phonenumber_by_id** — Get a phone number provisioned for SMS. When no supported content profile is explicitly set on an MMS-capable phone number, the system uses the "SMS Default" profile. This default profile allows all media types (/) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. (GET /api/v2/routing/sms/phonenumbers/{phoneNumberId}) Requires permission sms:phoneNumber:view. The id is the phoneNumberId. Required: id.
- **list_all_genesys_cloud_routing_sms_phonenumbers** — Get a list of provisioned phone numbers. When no supported content profile is explicitly set, the system uses the "SMS Default" profile. This default profile allows all media types (/) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. (GET /api/v2/routing/sms/phonenumbers) Requires permission sms:phoneNumber:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_sms_phonenumber_by_id** — Update a phone number provisioned for SMS. Use this endpoint to assign a custom supported content profile to an MMS-capable phone number. If no supported content profile is set, the phone number uses the "SMS Default" profile, which allows all media types (/) for inbound messages and specific image types (image/gif, image/jpeg, image/png)…. (PATCH /api/v2/routing/sms/phonenumbers/{phoneNumberId}) Requires permission sms:phoneNumber:edit. The id is the phoneNumberId. Required: id.
- **routing_user_directroutingbackup_settings_bulk_delete** — Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. (DELETE /api/v2/routing/users/{userId}/directroutingbackup/settings) Requires permission routing:directRoutingBackup:delete. Required: user_id.
- **routing_user_directroutingbackup_settings_bulk_update** — Update the user's Direct Routing Backup settings. (PUT /api/v2/routing/users/{userId}/directroutingbackup/settings) Requires permission routing:directRoutingBackup:edit. Required: user_id.
- **genesys_cloud_routing_user_directroutingbackup_settings_lookup** — Get the user's Direct Routing Backup settings. (GET /api/v2/routing/users/{userId}/directroutingbackup/settings) Requires permission routing:directRoutingBackup:view. Required: user_id.
- **genesys_cloud_routing_user_utilization_bulk_delete** — Delete the user's max utilization settings and revert to the organization-wide default. (DELETE /api/v2/routing/users/{userId}/utilization) Requires permission routing:utilization:manage. Required: user_id.
- **genesys_cloud_routing_user_utilization_bulk_update** — Update the user's max utilization settings. Include only those media types requiring custom configuration. (PUT /api/v2/routing/users/{userId}/utilization) Requires permission routing:utilization:manage. Required: user_id.
- **genesys_cloud_routing_user_utilization_lookup** — Get the user's max utilization settings. If not configured, the organization-wide default is returned. (GET /api/v2/routing/users/{userId}/utilization) Requires any of permissions routing:utilization:manage, routing:utilization:view. Required: user_id.
- **genesys_cloud_routing_utilization_bulk_delete** — Delete the organization-wide max utilization settings and revert to the system default. (DELETE /api/v2/routing/utilization) Requires permission routing:utilization:manage.
- **genesys_cloud_routing_utilization_bulk_update** — Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. (PUT /api/v2/routing/utilization) Requires permission routing:utilization:manage.
- **genesys_cloud_routing_utilization_lookup** — Get the organization-wide max utilization settings. (GET /api/v2/routing/utilization) Requires any of permissions routing:utilization:manage, routing:utilization:view.
- **list_all_genesys_cloud_routing_utilization_label_agents** — Get list of agent ids associated with a utilization label. (GET /api/v2/routing/utilization/labels/{labelId}/agents) Requires permission routing:utilization:view. Required: label_id.
- **create_a_genesys_cloud_routing_utilization_label** — Create a utilization label. (POST /api/v2/routing/utilization/labels) Requires permission routing:utilization:manage. Required: name.
- **delete_a_genesys_cloud_routing_utilization_label_by_id** — Delete a utilization label. (DELETE /api/v2/routing/utilization/labels/{labelId}) Requires permission routing:utilization:manage. The id is the labelId. Required: id.
- **get_single_genesys_cloud_routing_utilization_label_by_id** — Get details about this utilization label. (GET /api/v2/routing/utilization/labels/{labelId}) Requires permission routing:utilization:view. The id is the labelId. Required: id.
- **list_all_genesys_cloud_routing_utilization_labels** — Get list of utilization labels. (GET /api/v2/routing/utilization/labels) Requires permission routing:utilization:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_utilization_label_by_id** — Update a utilization label. (PUT /api/v2/routing/utilization/labels/{labelId}) Requires permission routing:utilization:manage. The id is the labelId. Required: id, name.
- **get_single_genesys_cloud_routing_wrapupcode_divisionview_by_id** — Get a simplified wrap-up code. (GET /api/v2/routing/wrapupcodes/divisionviews/{codeId}) Requires permission routing:wrapupCode:search. The id is the codeId. Required: id.
- **list_all_genesys_cloud_routing_wrapupcode_divisionviews** — Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported. (GET /api/v2/routing/wrapupcodes/divisionviews) Requires permission routing:wrapupCode:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_routing_wrapupcode** — Create a wrap-up code. (POST /api/v2/routing/wrapupcodes) Requires permission routing:wrapupCode:add. Required: name.
- **delete_a_genesys_cloud_routing_wrapupcode_by_id** — Delete wrap-up code. (DELETE /api/v2/routing/wrapupcodes/{codeId}) Requires permission routing:wrapupCode:delete. The id is the codeId. Required: id.
- **get_single_genesys_cloud_routing_wrapupcode_by_id** — Get details about this wrap-up code. (GET /api/v2/routing/wrapupcodes/{codeId}) Requires permission routing:wrapupCode:view. The id is the codeId. Required: id.
- **list_all_genesys_cloud_routing_wrapupcodes** — Get list of wrapup codes. (GET /api/v2/routing/wrapupcodes) Requires permission routing:wrapupCode:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_routing_wrapupcode_by_id** — Update wrap-up code. (PUT /api/v2/routing/wrapupcodes/{codeId}) Requires permission routing:wrapupCode:edit. The id is the codeId. Required: id, name.
- **get_single_genesys_cloud_scim_group_by_id** — Get a group. (GET /api/v2/scim/groups/{groupId}) Requires permission directory:group:edit. The id is the groupId. Required: id.
- **list_all_genesys_cloud_scim_groups** — Get a list of groups. (GET /api/v2/scim/groups) Requires permission directory:group:edit. Pages automatically with startIndex/count (25 per page).
- **genesys_cloud_scim_groups_partial_update** — Modify a group. (PATCH /api/v2/scim/groups/{groupId}) Requires permission directory:group:edit. Required: group_id, schemas.
- **update_a_genesys_cloud_scim_group_by_id** — Replace a group. (PUT /api/v2/scim/groups/{groupId}) Requires permission directory:group:edit. The id is the groupId. Required: id.
- **get_single_genesys_cloud_scim_resourcetype_by_id** — Get a resource type. (GET /api/v2/scim/resourcetypes/{resourceType}) The id is the resourceType. Required: id.
- **list_all_genesys_cloud_scim_resourcetypes** — Get a list of resource types. (GET /api/v2/scim/resourcetypes)
- **get_single_genesys_cloud_scim_schema_by_id** — Get a SCIM schema. (GET /api/v2/scim/schemas/{schemaId}) The id is the schemaId. Required: id.
- **list_all_genesys_cloud_scim_schemas** — Get a list of SCIM schemas. (GET /api/v2/scim/schemas)
- **genesys_cloud_scim_serviceproviderconfig_lookup** — Get a service provider's configuration. (GET /api/v2/scim/serviceproviderconfig)
- **create_a_genesys_cloud_scim_user** — Create a user. (POST /api/v2/scim/users) Requires any of permissions directory:user:add, authorization:grant:add, authorization:grant:delete, routing:skill:assign …. Required: userName, displayName.
- **delete_a_genesys_cloud_scim_user_by_id** — Delete a user. (DELETE /api/v2/scim/users/{userId}) Requires permission directory:user:delete. The id is the userId. Required: id.
- **get_single_genesys_cloud_scim_user_by_id** — Get a user. (GET /api/v2/scim/users/{userId}) The id is the userId. Required: id.
- **list_all_genesys_cloud_scim_users** — Get a list of users. To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". (GET /api/v2/scim/users) Pages automatically with startIndex/count (25 per page).
- **genesys_cloud_scim_users_partial_update** — Modify a user. (PATCH /api/v2/scim/users/{userId}) Requires any of permissions directory:user:edit, directory:user:setPassword, authorization:grant:add, authorization:grant:delete …. Required: user_id, schemas.
- **update_a_genesys_cloud_scim_user_by_id** — Replace a user. (PUT /api/v2/scim/users/{userId}) Requires any of permissions directory:user:edit, directory:user:setPassword, authorization:grant:add, authorization:grant:delete …. The id is the userId. Required: id.
- **get_single_genesys_cloud_scim_v_2_group_by_id** — Get a group. (GET /api/v2/scim/v2/groups/{groupId}) Requires permission directory:group:edit. The id is the groupId. Required: id.
- **list_all_genesys_cloud_scim_v_2_groups** — Get a list of groups. (GET /api/v2/scim/v2/groups) Requires permission directory:group:edit. Pages automatically with startIndex/count (25 per page). Required: filter.
- **genesys_cloud_scim_v_2_groups_partial_update** — Modify a group. (PATCH /api/v2/scim/v2/groups/{groupId}) Requires permission directory:group:edit. Required: group_id, schemas.
- **update_a_genesys_cloud_scim_v_2_group_by_id** — Replace a group. (PUT /api/v2/scim/v2/groups/{groupId}) Requires permission directory:group:edit. The id is the groupId. Required: id.
- **get_single_genesys_cloud_scim_v_2_resourcetype_by_id** — Get a resource type. (GET /api/v2/scim/v2/resourcetypes/{resourceType}) The id is the resourceType. Required: id.
- **list_all_genesys_cloud_scim_v_2_resourcetypes** — Get a list of resource types. (GET /api/v2/scim/v2/resourcetypes)
- **get_single_genesys_cloud_scim_v_2_schema_by_id** — Get a SCIM schema. (GET /api/v2/scim/v2/schemas/{schemaId}) The id is the schemaId. Required: id.
- **list_all_genesys_cloud_scim_v_2_schemas** — Get a list of SCIM schemas. (GET /api/v2/scim/v2/schemas)
- **genesys_cloud_scim_v_2_serviceproviderconfig_lookup** — Get a service provider's configuration. (GET /api/v2/scim/v2/serviceproviderconfig)
- **create_a_genesys_cloud_scim_v_2_user** — Create a user. (POST /api/v2/scim/v2/users) Requires any of permissions directory:user:add, authorization:grant:add, authorization:grant:delete, routing:skill:assign …. Required: userName, displayName.
- **delete_a_genesys_cloud_scim_v_2_user_by_id** — Delete a user. (DELETE /api/v2/scim/v2/users/{userId}) Requires permission directory:user:delete. The id is the userId. Required: id.
- **get_single_genesys_cloud_scim_v_2_user_by_id** — Get a user. (GET /api/v2/scim/v2/users/{userId}) The id is the userId. Required: id.
- **list_all_genesys_cloud_scim_v_2_users** — Get a list of users. To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". (GET /api/v2/scim/v2/users) Pages automatically with startIndex/count (25 per page).
- **genesys_cloud_scim_v_2_users_partial_update** — Modify a user. (PATCH /api/v2/scim/v2/users/{userId}) Requires any of permissions directory:user:edit, directory:user:setPassword, authorization:grant:add, authorization:grant:delete …. Required: user_id, schemas.
- **update_a_genesys_cloud_scim_v_2_user_by_id** — Replace a user. (PUT /api/v2/scim/v2/users/{userId}) Requires any of permissions directory:user:edit, directory:user:setPassword, authorization:grant:add, authorization:grant:delete …. The id is the userId. Required: id.
- **genesys_cloud_screenmonitor_session_details_lookup** — Get the details of all screen monitoring sessions for the current organization. (GET /api/v2/screenmonitors/sessions/details) Requires permission realtimeMonitor:screenSession:view.
- **create_a_genesys_cloud_screenmonitor_session_user_detail** — Get screen monitor session details for one or more users. (POST /api/v2/screenmonitors/sessions/users/details) Requires permission realtimeMonitor:screenSession:view.
- **genesys_cloud_screenmonitor_settings_bulk_update** — Update the Screen Monitor Settings for the Organization. (PUT /api/v2/screenmonitors/settings) Requires permission realtimeMonitor:settings:edit.
- **genesys_cloud_screenmonitor_settings_lookup** — Get the Screen Monitor Settings for the Organization. (GET /api/v2/screenmonitors/settings) Requires permission realtimeMonitor:settings:view.
- **list_all_genesys_cloud_screenmonitor_user_sessions** — Get all screen monitoring sessions for the supplied userId. (GET /api/v2/screenmonitors/users/{userId}/sessions) Requires any of permissions realtimeMonitor:screen:monitorConversation, realtimeMonitor:screen:monitorAgent. Required: user_id.
- **create_a_genesys_cloud_screenrecording_token** — Sign identifying information for screen recording. (POST /api/v2/screenrecording/token) Required: backgroundAssistantId.
- **list_all_genesys_cloud_script_divisionviews** — Get the metadata for a list of scripts. (GET /api/v2/scripts/divisionviews) Requires permission scripter:script:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_script_export** — Export a script via download service. (POST /api/v2/scripts/{scriptId}/export) Requires permission scripter:script:view. Required: script_id.
- **get_single_genesys_cloud_script_page_by_id** — Get a page. (GET /api/v2/scripts/{scriptId}/pages/{pageId}) Requires permission scripter:script:view. The id is the pageId. Required: id, script_id.
- **list_all_genesys_cloud_script_pages** — Get the list of pages. (GET /api/v2/scripts/{scriptId}/pages) Requires permission scripter:script:view. Required: script_id.
- **create_a_genesys_cloud_script_published** — Publish a script. (POST /api/v2/scripts/published) Requires permission scripter:publishedScript:add. Required: scriptId.
- **get_single_genesys_cloud_script_published_by_id** — Get the published script. (GET /api/v2/scripts/published/{scriptId}) Requires permission scripter:publishedScript:view. The id is the scriptId. Required: id.
- **list_all_genesys_cloud_script_published** — Get the published scripts. (GET /api/v2/scripts/published) Requires permission scripter:publishedScript:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_script_published_divisionview_variables_lookup** — Get the published variables. (GET /api/v2/scripts/published/divisionviews/{scriptId}/variables) Requires permission scripter:publishedScript:search. Required: script_id.
- **list_all_genesys_cloud_script_published_divisionviews** — Get the published scripts metadata. (GET /api/v2/scripts/published/divisionviews) Requires permission scripter:publishedScript:search. Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_script_published_page_by_id** — Get the published page. (GET /api/v2/scripts/published/{scriptId}/pages/{pageId}) Requires permission scripter:publishedScript:view. The id is the pageId. Required: id, script_id.
- **list_all_genesys_cloud_script_published_pages** — Get the list of published pages. (GET /api/v2/scripts/published/{scriptId}/pages) Requires permission scripter:publishedScript:view. Required: script_id.
- **genesys_cloud_script_published_variables_lookup** — Get the published variables. (GET /api/v2/scripts/published/{scriptId}/variables) Requires permission scripter:publishedScript:view. Required: script_id.
- **genesys_cloud_script_upload_status_lookup** — Get the upload status of an imported script. (GET /api/v2/scripts/uploads/{uploadId}/status) Requires permission scripter:script:view. Required: upload_id.
- **get_single_genesys_cloud_script_by_id** — Get a script. (GET /api/v2/scripts/{scriptId}) Requires permission scripter:script:view. The id is the scriptId. Required: id.
- **list_all_genesys_cloud_scripts** — Get the list of scripts. (GET /api/v2/scripts) Requires permission scripter:script:view. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_search** — Search resources. (POST /api/v2/search) Requires any of permissions directory:user:view, routing:skill:view. Required: types.
- **genesys_cloud_search_lookup** — Search using the q64 value returned from a previous search. (GET /api/v2/search) Requires permission directory:user:view. Required: q64.
- **create_a_genesys_cloud_search_suggest** — Suggest resources. (POST /api/v2/search/suggest) Requires permission directory:user:view. Required: types, query.
- **genesys_cloud_search_suggest_lookup** — Suggest resources using the q64 value returned from a previous suggest query. (GET /api/v2/search/suggest) Requires permission directory:user:view. Required: q64.
- **genesys_cloud_settings_executiondata_bulk_partial_update** — Edit the execution history on off setting. (PATCH /api/v2/settings/executiondata) Requires permission settings:executiondata:edit. Required: enabled.
- **genesys_cloud_settings_executiondata_lookup** — Get the execution history enabled setting. (GET /api/v2/settings/executiondata) Requires permission settings:executiondata:view.
- **list_all_socialmedia_analytics_aggregate_job_results** — Fetch a page of results for an async social media query. (GET /api/v2/socialmedia/analytics/aggregates/jobs/{jobId}/results) Requires permission socialmedia:postAggregate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_socialmedia_analytics_aggregate_job** — Query for social media aggregates asynchronously. (POST /api/v2/socialmedia/analytics/aggregates/jobs) Requires permission socialmedia:postAggregate:view. Required: interval, metrics.
- **get_socialmedia_analytics_aggregate_job_by_id** — Get status for async query for social media aggregates. (GET /api/v2/socialmedia/analytics/aggregates/jobs/{jobId}) Requires permission socialmedia:postAggregate:view. The id is the jobId. Required: id.
- **list_all_genesys_cloud_socialmedia_analytics_message_job_results** — Fetch a page of results for an async social media messages query. (GET /api/v2/socialmedia/analytics/messages/jobs/{jobId}/results) Requires permission socialmedia:postDetail:view. Pages automatically: pass the returned next_cursor to get the next page. Required: job_id.
- **create_a_genesys_cloud_socialmedia_analytics_message_job** — Query for social media messages asynchronously. (POST /api/v2/socialmedia/analytics/messages/jobs) Requires permission socialmedia:postDetail:view. Required: interval.
- **get_single_genesys_cloud_socialmedia_analytics_message_job_by_id** — Get status for async query for social media messages job. (GET /api/v2/socialmedia/analytics/messages/jobs/{jobId}) Requires permission socialmedia:postDetail:view. The id is the jobId. Required: id.
- **create_a_genesys_cloud_socialmedia_escalation_message** — Escalate message to a conversation manually. (POST /api/v2/socialmedia/escalations/messages) Requires permission socialmedia:message:escalate. Required: divisionId, socialMediaNormalizedMessageId.
- **create_a_genesys_cloud_socialmedia_escalationrule** — Create an escalation rule. (POST /api/v2/socialmedia/escalationrules) Requires permission socialmedia:escalationRules:add. Required: name, matchCriteria, priority, divisionId.
- **delete_a_genesys_cloud_socialmedia_escalationrule_by_id** — Delete an escalation rule. (DELETE /api/v2/socialmedia/escalationrules/{escalationRuleId}) Requires permission socialmedia:escalationRules:delete. The id is the escalationRuleId. Required: id.
- **get_single_genesys_cloud_socialmedia_escalationrule_by_id** — Get a single escalation rule. (GET /api/v2/socialmedia/escalationrules/{escalationRuleId}) Requires permission socialmedia:escalationRules:view. The id is the escalationRuleId. Required: id.
- **list_all_genesys_cloud_socialmedia_escalationrules** — Retrieve all escalation rules for a division. (GET /api/v2/socialmedia/escalationrules) Requires permission socialmedia:escalationRules:view. Pages automatically with pageNumber/pageSize. Required: divisionId.
- **update_a_genesys_cloud_socialmedia_escalationrule_by_id** — Update the escalation rule. (PUT /api/v2/socialmedia/escalationrules/{escalationRuleId}) Requires permission socialmedia:escalationRules:edit. The id is the escalationRuleId. Required: id, name, matchCriteria, priority, divisionId.
- **create_socialmedia_topic_dataingestionrule_facebook** — Create an Facebook data ingestion rule. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook) Requires permission socialmedia:facebookDataIngestionRule:add. Required: topic_id, name.
- **delete_socialmedia_topic_dataingestionrule_facebook_by_id** — Delete a Facebook data ingestion rule. (DELETE /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}) Requires permission socialmedia:facebookDataIngestionRule:delete. The id is the facebookIngestionRuleId. Required: id, topic_id.
- **get_socialmedia_topic_dataingestionrule_facebook_by_id** — Get a single Facebook data ingestion rule. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}) Requires permission socialmedia:facebookDataIngestionRule:view. The id is the facebookIngestionRuleId. Required: id, topic_id.
- **socialmedia_topic_dataingestionrule_facebook_partial_update** — Update the status of a Facebook data ingestion rule. (PATCH /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}) Requires permission socialmedia:facebookDataIngestionRule:edit. Required: topic_id, facebook_ingestion_rule_id, status.
- **update_socialmedia_topic_dataingestionrule_facebook_by_id** — Update the Facebook data ingestion rule. (PUT /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}) Requires permission socialmedia:facebookDataIngestionRule:edit. The id is the facebookIngestionRuleId. Required: id, topic_id, name.
- **get_socialmedia_topic_dataingestionrule_facebook_version_by_id** — Get a single Facebook data ingestion rule version. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions/{dataIngestionRuleVersion}) Requires permission socialmedia:facebookDataIngestionRule:view. The id is the dataIngestionRuleVersion. Required: id, topic_id, facebook_ingestion_rule_id.
- **list_all_socialmedia_topic_dataingestionrule_facebook_versions** — Get the Facebook data ingestion rule versions. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/facebook/{facebookIngestionRuleId}/versions) Requires permission socialmedia:facebookDataIngestionRule:view. Pages automatically with pageNumber/pageSize. Required: topic_id, facebook_ingestion_rule_id.
- **create_socialmedia_topic_dataingestionrule_instagram** — Create an Instagram data ingestion rule. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram) Requires permission socialmedia:instagramDataIngestionRule:add. Required: topic_id, name, integrationId.
- **delete_socialmedia_topic_dataingestionrule_instagram_by_id** — Delete a Instagram data ingestion rule. (DELETE /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}) Requires permission socialmedia:instagramDataIngestionRule:delete. The id is the instagramIngestionRuleId. Required: id, topic_id.
- **get_socialmedia_topic_dataingestionrule_instagram_by_id** — Get a single Instagram data ingestion rule. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}) Requires permission socialmedia:instagramDataIngestionRule:view. The id is the instagramIngestionRuleId. Required: id, topic_id.
- **socialmedia_topic_dataingestionrule_instagram_partial_update** — Update the status of a Instagram data ingestion rule. (PATCH /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}) Requires permission socialmedia:instagramDataIngestionRule:edit. Required: topic_id, instagram_ingestion_rule_id, status.
- **update_socialmedia_topic_dataingestionrule_instagram_by_id** — Update the Instagram data ingestion rule. (PUT /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}) Requires permission socialmedia:instagramDataIngestionRule:edit. The id is the instagramIngestionRuleId. Required: id, topic_id, name, integrationId.
- **get_socialmedia_topic_dataingestionrule_instagram_version_by_id** — Get a single Instagram data ingestion rule version. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions/{dataIngestionRuleVersion}) Requires permission socialmedia:instagramDataIngestionRule:view. The id is the dataIngestionRuleVersion. Required: id, topic_id, instagram_ingestion_rule_id.
- **list_all_socialmedia_topic_dataingestionrule_instagram_versions** — Get the Instagram data ingestion rule versions. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/instagram/{instagramIngestionRuleId}/versions) Requires permission socialmedia:instagramDataIngestionRule:view. Pages automatically with pageNumber/pageSize. Required: topic_id, instagram_ingestion_rule_id.
- **create_a_genesys_cloud_socialmedia_topic_dataingestionrule_open** — Create an open data ingestion rule. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open) Requires permission socialmedia:openDataIngestionRule:add. Required: topic_id, name, externalSource.
- **delete_socialmedia_topic_dataingestionrule_open_by_id** — Delete a open data ingestion rule. (DELETE /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}) Requires permission socialmedia:openDataIngestionRule:delete. The id is the openId. Required: id, topic_id.
- **get_socialmedia_topic_dataingestionrule_open_by_id** — Get a single open data ingestion rule. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}) Requires permission socialmedia:openDataIngestionRule:view. The id is the openId. Required: id, topic_id.
- **socialmedia_topic_dataingestionrule_open_partial_update** — Update the status of a open data ingestion rule. (PATCH /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}) Requires permission socialmedia:openDataIngestionRule:edit. Required: topic_id, open_id, status.
- **update_socialmedia_topic_dataingestionrule_open_by_id** — Update the open data ingestion rule. (PUT /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}) Requires permission socialmedia:openDataIngestionRule:edit. The id is the openId. Required: id, topic_id, name, externalSource.
- **create_socialmedia_topic_dataingestionrule_open_message_bulk** — Ingest a list of open social messages to an ingestion rule on a topic. This endpoint will ingest and enrich these messages. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk) Requires permission socialmedia:message:receive. Required: topic_id, rule_id.
- **create_socialmedia_topic_dataingestionrule_open_reaction_bulk** — Ingest a list of open social reactions to an ingestion rule on a topic. This endpoint will ingest these reactions. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk) Requires permission socialmedia:reaction:receive. Required: topic_id, rule_id, events.
- **get_socialmedia_topic_dataingestionrule_open_version_by_id** — Get a single Open data ingestion rule version. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions/{dataIngestionRuleVersion}) Requires permission socialmedia:openDataIngestionRule:view. The id is the dataIngestionRuleVersion. Required: id, topic_id, open_id.
- **list_all_socialmedia_topic_dataingestionrule_open_versions** — Get the Open data ingestion rule versions. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{openId}/versions) Requires permission socialmedia:openDataIngestionRule:view. Pages automatically with pageNumber/pageSize. Required: topic_id, open_id.
- **create_socialmedia_topic_dataingestionrule_twitter** — Create an twitter data ingestion rule. (POST /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter) Requires permission socialmedia:twitterDataIngestionRule:add. Required: topic_id, name, searchTerms.
- **delete_socialmedia_topic_dataingestionrule_twitter_by_id** — Delete a X (formally Twitter) data ingestion rule. (DELETE /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}) Requires permission socialmedia:twitterDataIngestionRule:delete. The id is the twitterIngestionRuleId. Required: id, topic_id.
- **get_socialmedia_topic_dataingestionrule_twitter_by_id** — Get a single X (formally Twitter) data ingestion rule. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}) Requires permission socialmedia:twitterDataIngestionRule:view. The id is the twitterIngestionRuleId. Required: id, topic_id.
- **socialmedia_topic_dataingestionrule_twitter_partial_update** — Update the status of a X (formally Twitter) data ingestion rule. (PATCH /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}) Requires permission socialmedia:twitterDataIngestionRule:edit. Required: topic_id, twitter_ingestion_rule_id, status.
- **update_socialmedia_topic_dataingestionrule_twitter_by_id** — Update the X (formally Twitter) data ingestion rule. (PUT /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}) Requires permission socialmedia:twitterDataIngestionRule:edit. The id is the twitterIngestionRuleId. Required: id, topic_id, name, searchTerms.
- **get_socialmedia_topic_dataingestionrule_twitter_version_by_id** — Get a single X (formally Twitter) data ingestion rule version. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions/{dataIngestionRuleVersion}) Requires permission socialmedia:twitterDataIngestionRule:view. The id is the dataIngestionRuleVersion. Required: id, topic_id, twitter_ingestion_rule_id.
- **list_all_socialmedia_topic_dataingestionrule_twitter_versions** — Get the Open data ingestion rule versions. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules/twitter/{twitterIngestionRuleId}/versions) Requires permission socialmedia:twitterDataIngestionRule:view. Pages automatically with pageNumber/pageSize. Required: topic_id, twitter_ingestion_rule_id.
- **list_all_genesys_cloud_socialmedia_topic_dataingestionrules** — Retrieve all social topic data ingestion rules with pagination. (GET /api/v2/socialmedia/topics/{topicId}/dataingestionrules) Requires permission socialmedia:topic:view. Pages automatically with pageNumber/pageSize. Required: topic_id.
- **create_a_genesys_cloud_socialmedia_topic** — Create a social topic. (POST /api/v2/socialmedia/topics) Requires permission socialmedia:topic:add. Required: name, divisionId.
- **delete_a_genesys_cloud_socialmedia_topic_by_id** — Delete a social topic. (DELETE /api/v2/socialmedia/topics/{topicId}) Requires permission socialmedia:topic:delete. The id is the topicId. Required: id.
- **get_single_genesys_cloud_socialmedia_topic_by_id** — Get a single social topic. (GET /api/v2/socialmedia/topics/{topicId}) Requires permission socialmedia:topic:view. The id is the topicId. Required: id.
- **list_all_genesys_cloud_socialmedia_topics** — Retrieve all social topics. (GET /api/v2/socialmedia/topics) Requires permission socialmedia:topic:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_socialmedia_topic_by_id** — Update a social topic. (PATCH /api/v2/socialmedia/topics/{topicId}) Requires permission socialmedia:topic:edit. The id is the topicId. Required: id.
- **create_a_genesys_cloud_socialmedia_twitter_historical_tweet** — Retrieves historical tweet count for search terms, optional countries list and the current limit and usage for the organization. (POST /api/v2/socialmedia/twitter/historical/tweets) Requires permission socialmedia:twitterDataIngestionRule:add. Required: searchTerms.
- **create_a_genesys_cloud_speechandtextanalytics_category** — Create new Speech & Text Analytics category. (POST /api/v2/speechandtextanalytics/categories) Requires permission speechAndTextAnalytics:category:add. Required: name, interactionType, criteria.
- **delete_a_genesys_cloud_speechandtextanalytics_category_by_id** — Delete a Speech & Text Analytics category by ID. (DELETE /api/v2/speechandtextanalytics/categories/{categoryId}) Requires permission speechAndTextAnalytics:category:delete. The id is the categoryId. Required: id.
- **get_single_genesys_cloud_speechandtextanalytics_category_by_id** — Get a Speech & Text Analytics Category by ID. (GET /api/v2/speechandtextanalytics/categories/{categoryId}) Requires permission speechAndTextAnalytics:category:view. The id is the categoryId. Required: id.
- **list_all_genesys_cloud_speechandtextanalytics_categories** — Get the list of Speech and Text Analytics categories. (GET /api/v2/speechandtextanalytics/categories) Requires permission speechAndTextAnalytics:category:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_speechandtextanalytics_category_by_id** — Update a Speech & Text Analytics category by ID. (PUT /api/v2/speechandtextanalytics/categories/{categoryId}) Requires permission speechAndTextAnalytics:category:edit. The id is the categoryId. Required: id, name, interactionType, criteria.
- **list_all_speechandtextanalytics_conversation_categories** — Get the list of detected Speech and Text Analytics categories of conversation. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/categories) Requires permission speechAndTextAnalytics:data:view. Pages automatically with pageNumber/pageSize. Required: conversation_id.
- **speechandtextanalytics_conversation_sentiments_lookup** — Get sentiment data. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/sentiments) Requires permission speechAndTextAnalytics:sentimentData:view. Required: conversation_id.
- **list_all_speechandtextanalytics_conversation_summaries** — Get conversation summaries by conversation id. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/summaries) Requires permission speechAndTextAnalytics:aiSummary:view. Required: conversation_id.
- **get_speechandtextanalytics_conversation_by_id** — Get Speech and Text Analytics for a specific conversation. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}) Requires permissions recording:recording:view, speechAndTextAnalytics:data:view. The id is the conversationId. Required: id.
- **create_a_genesys_cloud_speechandtextanalytics_dictionaryfeedback** — Create a Speech & Text Analytics DictionaryFeedback. (POST /api/v2/speechandtextanalytics/dictionaryfeedback) Requires permission speechAndTextAnalytics:dictionaryterm:add. Required: term, dialect.
- **delete_speechandtextanalytics_dictionaryfeedback_by_id** — Delete a Speech & Text Analytics DictionaryFeedback by Id. (DELETE /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}) Requires permission speechAndTextAnalytics:dictionaryterm:delete. The id is the dictionaryFeedbackId. Required: id.
- **get_speechandtextanalytics_dictionaryfeedback_by_id** — Get a Speech & Text Analytics dictionary feedback by id. (GET /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}) Requires permission speechAndTextAnalytics:dictionaryterm:view. The id is the dictionaryFeedbackId. Required: id.
- **list_all_genesys_cloud_speechandtextanalytics_dictionaryfeedback** — Get the list of Speech & Text Analytics dictionary feedbacks. (GET /api/v2/speechandtextanalytics/dictionaryfeedback) Requires permission speechAndTextAnalytics:dictionaryterm:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_speechandtextanalytics_dictionaryfeedback_by_id** — Update existing Speech & Text Analytics dictionary feedback by id. (PUT /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId}) Requires permission speechAndTextAnalytics:dictionaryterm:edit. The id is the dictionaryFeedbackId. Required: id, term, dialect.
- **create_speechandtextanalytics_program_general_job** — Create new Speech & Text Analytics general program job. (POST /api/v2/speechandtextanalytics/programs/general/jobs) Requires permissions speechAndTextAnalytics:program:add, speechAndTextAnalytics:program:edit, speechAndTextAnalytics:topic:add, speechAndTextAnalytics:topic:edit. Required: dialect.
- **get_speechandtextanalytics_program_general_job_by_id** — Get a Speech & Text Analytics general program job by id. (GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId}) Requires permissions speechAndTextAnalytics:program:add, speechAndTextAnalytics:program:edit, speechAndTextAnalytics:topic:add, speechAndTextAnalytics:topic:edit. The id is the jobId. Required: id.
- **speechandtextanalytics_program_mappings_bulk_update** — Set Speech & Text Analytics program mappings to queues and flows. (PUT /api/v2/speechandtextanalytics/programs/{programId}/mappings) Requires permission speechAndTextAnalytics:program:edit. Required: program_id, queueIds, flowIds.
- **list_all_genesys_cloud_speechandtextanalytics_program_mappings** — Get the list of Speech & Text Analytics programs mappings to queues and flows. (GET /api/v2/speechandtextanalytics/programs/mappings) Requires permission speechAndTextAnalytics:program:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_speechandtextanalytics_program_mappings_lookup** — Get Speech & Text Analytics program mappings to queues and flows by id. (GET /api/v2/speechandtextanalytics/programs/{programId}/mappings) Requires permission speechAndTextAnalytics:program:view. Required: program_id.
- **create_a_genesys_cloud_speechandtextanalytics_program_publishjob** — Create new Speech & Text Analytics publish programs job. (POST /api/v2/speechandtextanalytics/programs/publishjobs) Requires permission speechAndTextAnalytics:program:publish. Required: programIds.
- **get_speechandtextanalytics_program_publishjob_by_id** — Get a Speech & Text Analytics publish programs job by id. (GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId}) Requires permission speechAndTextAnalytics:program:publish. The id is the jobId. Required: id.
- **speechandtextanalytics_program_settings_insights_bulk_update** — Update AI Insights settings of a program. (PUT /api/v2/speechandtextanalytics/programs/{programId}/settings/insights) Requires permissions speechAndTextAnalytics:program:edit, speechAndTextAnalytics:insightsSettings:edit. Required: program_id, enabled.
- **list_all_speechandtextanalytics_program_settings_insights** — Get the list of program AI Insights settings for the organization. (GET /api/v2/speechandtextanalytics/programs/settings/insights) Requires permissions speechAndTextAnalytics:program:view, speechAndTextAnalytics:insightsSettings:view. Pages automatically with pageNumber/pageSize.
- **speechandtextanalytics_program_settings_insights_lookup** — Get AI Insights settings of a program. (GET /api/v2/speechandtextanalytics/programs/{programId}/settings/insights) Requires permissions speechAndTextAnalytics:program:view, speechAndTextAnalytics:insightsSettings:view. Required: program_id.
- **get_speechandtextanalytics_program_topiclink_job_by_id** — Get a Speech & Text Analytics program-topic links job by id. (GET /api/v2/speechandtextanalytics/programs/topiclinks/jobs/{jobId}) Requires permission speechAndTextAnalytics:program:view. The id is the jobId. Required: id.
- **list_speechandtextanalytics_program_transcriptionengine_dialects** — Get supported dialects for each transcription engine. (GET /api/v2/speechandtextanalytics/programs/transcriptionengines/dialects)
- **speechandtextanalytics_program_transcriptionengines_bulk_update** — Update transcription engine settings of a program. (PUT /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines) Requires permission speechAndTextAnalytics:program:edit. Required: program_id, transcriptionEngines.
- **speechandtextanalytics_program_transcriptionengines_lookup** — Get transcription engine settings of a program. (GET /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines) Requires permission speechAndTextAnalytics:program:view. Required: program_id.
- **list_all_speechandtextanalytics_program_unpublished** — Get the list of Speech & Text Analytics unpublished programs. (GET /api/v2/speechandtextanalytics/programs/unpublished) Requires permission speechAndTextAnalytics:program:view. Pages automatically: pass the returned next_cursor to get the next page.
- **create_a_genesys_cloud_speechandtextanalytics_program** — Create new Speech & Text Analytics program. (POST /api/v2/speechandtextanalytics/programs) Requires permission speechAndTextAnalytics:program:add. Required: name.
- **delete_a_genesys_cloud_speechandtextanalytics_program_by_id** — Delete a Speech & Text Analytics program by id. (DELETE /api/v2/speechandtextanalytics/programs/{programId}) Requires permission speechAndTextAnalytics:program:delete. The id is the programId. Required: id.
- **get_single_genesys_cloud_speechandtextanalytics_program_by_id** — Get a Speech & Text Analytics program by id. (GET /api/v2/speechandtextanalytics/programs/{programId}) Requires permission speechAndTextAnalytics:program:view. The id is the programId. Required: id.
- **list_all_genesys_cloud_speechandtextanalytics_programs** — Get the list of Speech & Text Analytics programs. (GET /api/v2/speechandtextanalytics/programs) Requires permission speechAndTextAnalytics:program:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_speechandtextanalytics_program_by_id** — Update existing Speech & Text Analytics program. (PUT /api/v2/speechandtextanalytics/programs/{programId}) Requires permission speechAndTextAnalytics:program:edit. The id is the programId. Required: id, name.
- **list_all_genesys_cloud_speechandtextanalytics_sentiment_dialects** — Get the list of Speech & Text Analytics sentiment supported dialects. (GET /api/v2/speechandtextanalytics/sentiment/dialects)
- **speechandtextanalytics_sentimentfeedback_bulk_delete** — Delete All Speech & Text Analytics SentimentFeedback. (DELETE /api/v2/speechandtextanalytics/sentimentfeedback) Requires permission speechAndTextAnalytics:feedback:delete.
- **create_a_genesys_cloud_speechandtextanalytics_sentimentfeedback** — Create a Speech & Text Analytics SentimentFeedback. (POST /api/v2/speechandtextanalytics/sentimentfeedback) Requires permission speechAndTextAnalytics:feedback:add. Required: phrase, dialect, feedbackValue.
- **delete_speechandtextanalytics_sentimentfeedback_by_id** — Delete a Speech & Text Analytics SentimentFeedback by Id. (DELETE /api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}) Requires permission speechAndTextAnalytics:feedback:delete. The id is the sentimentFeedbackId. Required: id.
- **list_all_genesys_cloud_speechandtextanalytics_sentimentfeedback** — Get the list of Speech & Text Analytics SentimentFeedback. (GET /api/v2/speechandtextanalytics/sentimentfeedback) Requires permission speechAndTextAnalytics:feedback:view.
- **speechandtextanalytics_settings_bulk_partial_update** — Patch Speech And Text Analytics Settings. (PATCH /api/v2/speechandtextanalytics/settings) Requires permission speechAndTextAnalytics:settings:edit.
- **genesys_cloud_speechandtextanalytics_settings_bulk_update** — Update Speech And Text Analytics Settings. (PUT /api/v2/speechandtextanalytics/settings) Requires permission speechAndTextAnalytics:settings:edit.
- **genesys_cloud_speechandtextanalytics_settings_lookup** — Get Speech And Text Analytics Settings. (GET /api/v2/speechandtextanalytics/settings) Requires permission speechAndTextAnalytics:settings:view.
- **list_all_genesys_cloud_speechandtextanalytics_topic_dialects** — Get list of supported Speech & Text Analytics topics dialects. (GET /api/v2/speechandtextanalytics/topics/dialects)
- **list_all_genesys_cloud_speechandtextanalytics_topic_general** — Get the Speech & Text Analytics general topics for a given dialect. (GET /api/v2/speechandtextanalytics/topics/general) Requires permission speechAndTextAnalytics:topic:view.
- **list_all_speechandtextanalytics_topic_general_status** — Get the list of general topics from the org and the system with their current status. (GET /api/v2/speechandtextanalytics/topics/general/status) Requires permission speechAndTextAnalytics:topic:view.
- **create_speechandtextanalytics_topic_generatedphrase_job** — Create new Speech & Text Analytics GenAI topic phrases generation job. (POST /api/v2/speechandtextanalytics/topics/generatedphrases/jobs) Requires permission speechAndTextAnalytics:topic:addAIPhrases. Required: topic.
- **get_speechandtextanalytics_topic_generatedphrase_job_by_id** — Get a Speech & Text Analytics GenAI phrases job by id. (GET /api/v2/speechandtextanalytics/topics/generatedphrases/jobs/{jobId}) Requires permission speechAndTextAnalytics:topic:addAIPhrases. The id is the jobId. Required: id.
- **create_a_genesys_cloud_speechandtextanalytics_topic_publishjob** — Create new Speech & Text Analytics publish topics job. (POST /api/v2/speechandtextanalytics/topics/publishjobs) Requires permission speechAndTextAnalytics:topic:publish. Required: topicIds.
- **get_speechandtextanalytics_topic_publishjob_by_id** — Get a Speech & Text Analytics publish topics job by id. (GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId}) Requires permission speechAndTextAnalytics:topic:publish. The id is the jobId. Required: id.
- **create_speechandtextanalytics_topic_testphrase_job** — Create new Speech & Text Analytics test topic phrase job. (POST /api/v2/speechandtextanalytics/topics/testphrase/jobs) Requires permission speechAndTextAnalytics:topic:testPhrase. Required: topic.
- **get_speechandtextanalytics_topic_testphrase_job_by_id** — Get a Speech & Text Analytics test topics phrase job by id. (GET /api/v2/speechandtextanalytics/topics/testphrase/jobs/{jobId}) Requires permission speechAndTextAnalytics:topic:testPhrase. The id is the jobId. Required: id.
- **create_a_genesys_cloud_speechandtextanalytics_topic** — Create new Speech & Text Analytics topic. (POST /api/v2/speechandtextanalytics/topics) Requires permission speechAndTextAnalytics:topic:add. Required: name, dialect.
- **delete_a_genesys_cloud_speechandtextanalytics_topic_by_id** — Delete a Speech & Text Analytics topic by id. (DELETE /api/v2/speechandtextanalytics/topics/{topicId}) Requires permission speechAndTextAnalytics:topic:delete. The id is the topicId. Required: id.
- **get_single_genesys_cloud_speechandtextanalytics_topic_by_id** — Get a Speech & Text Analytics topic by id. (GET /api/v2/speechandtextanalytics/topics/{topicId}) Requires permission speechAndTextAnalytics:topic:view. The id is the topicId. Required: id.
- **list_all_genesys_cloud_speechandtextanalytics_topics** — Get the list of Speech & Text Analytics topics. (GET /api/v2/speechandtextanalytics/topics) Requires permission speechAndTextAnalytics:topic:view. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_speechandtextanalytics_topic_by_id** — Update existing Speech & Text Analytics topic. (PUT /api/v2/speechandtextanalytics/topics/{topicId}) Requires permission speechAndTextAnalytics:topic:edit. The id is the topicId. Required: id, name, dialect.
- **genesys_cloud_speechandtextanalytics_transcripts_search** — Search resources. (POST /api/v2/speechandtextanalytics/transcripts/search) Requires any of permissions analytics:conversationDetail:view, recording:recording:view, recording:recordingSegment:view, analytics:transcriptcontent:search …. Required: types.
- **get_speechandtextanalytics_translation_language_conversation** — Translate a single interaction recording (or an email conversation). (GET /api/v2/speechandtextanalytics/translations/languages/{languageId}/conversations/{conversationId}) Requires permission speechAndTextAnalytics:translation:view. The id is the conversationId. Required: id, language_id.
- **list_all_speechandtextanalytics_translation_languages** — Get supported translation languages. (GET /api/v2/speechandtextanalytics/translations/languages) Requires permission speechAndTextAnalytics:translation:view.
- **list_speechtextanalytics_conv_communication_transcriptoutline** — Get the transcript outline for a specific conversation and communication. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcriptoutline) Requires permission speechAndTextAnalytics:aiOutline:view. Required: conversation_id, communication_id.
- **speechtextanalytics_conv_communication_transcripturl_lookup** — Get the pre-signed S3 URL for the transcript of a specific communication of a conversation. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl) Requires permissions recording:recording:view, speechAndTextAnalytics:data:view. Required: conversation_id, communication_id.
- **speechtextanalytics_conv_communication_transcripturls_lookup** — Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation. (GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls) Requires any of permissions recording:recording:view, recording:recordingSegment:view. Required: conversation_id, communication_id.
- **sta_program_settings_processing_bulk_partial_update** — Update program processing settings. (PATCH /api/v2/speechandtextanalytics/programs/{programId}/settings/processing) Requires permissions speechAndTextAnalytics:program:edit, speechAndTextAnalytics:processingSettings:edit. Required: program_id.
- **list_all_genesys_cloud_sta_program_settings_processing** — Get the list of program processing settings for the organization. (GET /api/v2/speechandtextanalytics/programs/settings/processing) Requires permissions speechAndTextAnalytics:program:view, speechAndTextAnalytics:processingSettings:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_sta_program_settings_processing_lookup** — Get program processing settings. (GET /api/v2/speechandtextanalytics/programs/{programId}/settings/processing) Requires permissions speechAndTextAnalytics:program:view, speechAndTextAnalytics:processingSettings:view. Required: program_id.
- **genesys_cloud_station_associateduser_bulk_delete** — Unassigns the user assigned to this station. (DELETE /api/v2/stations/{stationId}/associateduser) Requires permission telephony:station:disassociate. Required: station_id.
- **get_single_genesys_cloud_station_by_id** — Get station. (GET /api/v2/stations/{stationId}) The id is the stationId. Required: id.
- **list_all_genesys_cloud_stations** — Get the list of available stations. (GET /api/v2/stations) Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_systempresences** — Get the list of SystemPresences. (GET /api/v2/systempresences)
- **list_all_genesys_cloud_taskmanagement_workbin_history** — Get a listing of a workbin's attribute change history. (GET /api/v2/taskmanagement/workbins/{workbinId}/history) Requires permission workitems:workbin:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workbin_id.
- **get_single_genesys_cloud_taskmanagement_workbin_version_by_id** — Get a version of a workbin. (GET /api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion}) Requires permission workitems:workbin:view. The id is the entityVersion. Required: id, workbin_id.
- **list_all_genesys_cloud_taskmanagement_workbin_versions** — Get all versions of a workbin. (GET /api/v2/taskmanagement/workbins/{workbinId}/versions) Requires permission workitems:workbin:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workbin_id.
- **create_a_genesys_cloud_taskmanagement_workbin** — Create a workbin. (POST /api/v2/taskmanagement/workbins) Requires permission workitems:workbin:add. Required: name.
- **delete_a_genesys_cloud_taskmanagement_workbin_by_id** — Delete a workbin. (DELETE /api/v2/taskmanagement/workbins/{workbinId}) Requires permission workitems:workbin:delete. The id is the workbinId. Required: id.
- **get_single_genesys_cloud_taskmanagement_workbin_by_id** — Get a workbin. (GET /api/v2/taskmanagement/workbins/{workbinId}) Requires permission workitems:workbin:view. The id is the workbinId. Required: id.
- **genesys_cloud_taskmanagement_workbins_search** — Query for workbins. (POST /api/v2/taskmanagement/workbins/query) Requires permission workitems:workbin:view. Required: filters.
- **update_a_genesys_cloud_taskmanagement_workbin_by_id** — Update the attributes of a workbin. (PATCH /api/v2/taskmanagement/workbins/{workbinId}) Requires permission workitems:workbin:edit. The id is the workbinId. Required: id.
- **genesys_cloud_taskmanagement_workitem_acd_cancel** — Cancel the assignment process for a workitem that is currently queued for assignment through ACD. (POST /api/v2/taskmanagement/workitems/{workitemId}/acd/cancel) Requires permission workitems:workitem:cancelRouting. Required: workitem_id.
- **taskmanagement_workitem_assignment_bulk_partial_update** — Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. (PATCH /api/v2/taskmanagement/workitems/{workitemId}/assignment) Requires any of permissions workitems:workitem:pull, workitems:workitem:assign. Required: workitem_id, id.
- **taskmanagement_workitem_bulk_add_job_results_lookup** — Get bulk add job results. (GET /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results) Requires permission workitems:bulkAddJobResults:view. Required: bulk_job_id.
- **create_a_genesys_cloud_taskmanagement_workitem_bulk_add_job** — Create a workitem bulk add job. (POST /api/v2/taskmanagement/workitems/bulk/add/jobs) Requires permission workitems:bulkAddJob:add. Required: entities.
- **delete_taskmanagement_workitem_bulk_add_job_by_id** — Delete a bulk add job. (DELETE /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}) Requires permission workitems:bulkAddJob:delete. The id is the bulkJobId. Required: id.
- **get_taskmanagement_workitem_bulk_add_job_by_id** — Get the bulk add job associated with the job id. (GET /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}) Requires permission workitems:bulkAddJob:view. The id is the bulkJobId. Required: id.
- **update_taskmanagement_workitem_bulk_add_job_by_id** — Update workitem bulk add job. (PATCH /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}) Requires permission workitems:bulkAddJob:edit. The id is the bulkJobId. Required: id, state.
- **list_all_genesys_cloud_taskmanagement_workitem_bulk_job_user_me** — Get bulk jobs created by the currently logged in user. (GET /api/v2/taskmanagement/workitems/bulk/jobs/users/me) Requires permission workitems:bulkJob:view. Pages automatically: pass the returned next_cursor to get the next page.
- **taskmanagement_workitem_bulk_terminate_job_results_lookup** — Get bulk terminate job results. (GET /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results) Requires permission workitems:bulkTerminateJobResults:view. Required: bulk_job_id.
- **create_taskmanagement_workitem_bulk_terminate_job** — Create a workitem bulk terminate job. (POST /api/v2/taskmanagement/workitems/bulk/terminate/jobs) Requires permission workitems:bulkTerminateJob:add. Required: entities.
- **delete_taskmanagement_workitem_bulk_terminate_job_by_id** — Delete a Bulk job. (DELETE /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}) Requires permission workitems:bulkTerminateJob:delete. The id is the bulkJobId. Required: id.
- **get_taskmanagement_workitem_bulk_terminate_job_by_id** — Get the bulk job associated with the job id. (GET /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}) Requires permission workitems:bulkTerminateJob:view. The id is the bulkJobId. Required: id.
- **update_taskmanagement_workitem_bulk_terminate_job_by_id** — Update workitem bulk terminate job. (PATCH /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}) Requires permission workitems:bulkTerminateJob:edit. The id is the bulkJobId. Required: id, state.
- **create_a_genesys_cloud_taskmanagement_workitem_disconnect** — Disconnect the assignee of the workitem. (POST /api/v2/taskmanagement/workitems/{workitemId}/disconnect) Requires permission workitems:workitem:disconnect. Required: workitem_id.
- **list_all_genesys_cloud_taskmanagement_workitem_history** — Get a listing of a workitem's attribute change history. (GET /api/v2/taskmanagement/workitems/{workitemId}/history) Requires permission workitems:workitem:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workitem_id.
- **list_all_genesys_cloud_taskmanagement_workitem_query_job_results** — Get results from for workitem query job. (GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results) Requires permission workitems:queryJobResults:view. Required: job_id.
- **create_a_genesys_cloud_taskmanagement_workitem_query_job** — Create a workitem query job. (POST /api/v2/taskmanagement/workitems/query/jobs) Requires permission workitems:queryJob:add. Required: filters.
- **get_single_genesys_cloud_taskmanagement_workitem_query_job_by_id** — Get the workitem query job associated with the job id. (GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}) Requires permission workitems:queryJob:view. The id is the jobId. Required: id.
- **get_taskmanagement_workitem_schema_coretype_by_id** — Get a specific named core type. (GET /api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName}) Requires permission workitems:workitemSchema:view. The id is the coreTypeName. Required: id.
- **list_all_genesys_cloud_taskmanagement_workitem_schema_coretypes** — Get the core types from which all schemas are built. (GET /api/v2/taskmanagement/workitems/schemas/coretypes) Requires permission workitems:workitemSchema:view.
- **genesys_cloud_taskmanagement_workitem_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/taskmanagement/workitems/schemas/limits) Requires permission workitems:workitemSchema:view.
- **get_taskmanagement_workitem_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId}) Requires permission workitems:workitemSchema:view. The id is the versionId. Required: id, schema_id.
- **list_all_genesys_cloud_taskmanagement_workitem_schema_versions** — Get all versions of a schema. (GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions) Requires permission workitems:workitemSchema:view. Required: schema_id.
- **create_a_genesys_cloud_taskmanagement_workitem_schema** — Create a schema. (POST /api/v2/taskmanagement/workitems/schemas) Requires permission workitems:workitemSchema:add. Required: version, jsonSchema.
- **delete_a_genesys_cloud_taskmanagement_workitem_schema_by_id** — Delete a schema. (DELETE /api/v2/taskmanagement/workitems/schemas/{schemaId}) Requires permission workitems:workitemSchema:delete. The id is the schemaId. Required: id.
- **get_single_genesys_cloud_taskmanagement_workitem_schema_by_id** — Get a schema. (GET /api/v2/taskmanagement/workitems/schemas/{schemaId}) Requires permission workitems:workitemSchema:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_taskmanagement_workitem_schemas** — Get a list of schemas. (GET /api/v2/taskmanagement/workitems/schemas) Requires permission workitems:workitemSchema:view.
- **update_a_genesys_cloud_taskmanagement_workitem_schema_by_id** — Update a schema. (PUT /api/v2/taskmanagement/workitems/schemas/{schemaId}) Requires permission workitems:workitemSchema:edit. The id is the schemaId. Required: id, version, jsonSchema.
- **create_a_genesys_cloud_taskmanagement_workitem_terminate** — Terminate a workitem. (POST /api/v2/taskmanagement/workitems/{workitemId}/terminate) Requires permission workitems:workitem:terminate. Required: workitem_id.
- **taskmanagement_workitem_user_me_wrapups_bulk_partial_update** — Add/Remove a wrapup code for the current user in a workitem. (PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups) Requires permission workitems:wrapupSelf:edit. Required: workitem_id, action, wrapupCode.
- **taskmanagement_workitem_user_wrapups_bulk_partial_update** — Add/Remove a wrapup code for a given user in a workitem. (PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups) Requires permission workitems:wrapup:edit. Required: workitem_id, user_id, action, wrapupCode.
- **list_all_genesys_cloud_taskmanagement_workitem_user_wrapups** — Get all wrapup codes added for the given user for a workitem. (GET /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups) Requires permission workitems:wrapup:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workitem_id, user_id.
- **get_single_genesys_cloud_taskmanagement_workitem_version_by_id** — Get a version of a workitem. (GET /api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion}) Requires permission workitems:workitem:view. The id is the entityVersion. Required: id, workitem_id.
- **list_all_genesys_cloud_taskmanagement_workitem_versions** — Get all versions of a workitem. (GET /api/v2/taskmanagement/workitems/{workitemId}/versions) Requires permission workitems:workitem:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workitem_id.
- **list_all_genesys_cloud_taskmanagement_workitem_wrapups** — Get all wrapup codes added for all users for a workitem. (GET /api/v2/taskmanagement/workitems/{workitemId}/wrapups) Requires permission workitems:wrapup:view. Pages automatically: pass the returned next_cursor to get the next page. Required: workitem_id.
- **create_a_genesys_cloud_taskmanagement_workitem** — Create a workitem. (POST /api/v2/taskmanagement/workitems) Requires permission workitems:workitem:add. Required: name, typeId.
- **delete_a_genesys_cloud_taskmanagement_workitem_by_id** — Delete a workitem. (DELETE /api/v2/taskmanagement/workitems/{workitemId}) Requires permission workitems:workitem:delete. The id is the workitemId. Required: id.
- **get_single_genesys_cloud_taskmanagement_workitem_by_id** — Get a workitem. (GET /api/v2/taskmanagement/workitems/{workitemId}) Requires permission workitems:workitem:view. The id is the workitemId. Required: id.
- **genesys_cloud_taskmanagement_workitems_search** — Query for workitems. This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed. (POST /api/v2/taskmanagement/workitems/query) Requires permission workitems:workitem:view. Required: filters.
- **update_a_genesys_cloud_taskmanagement_workitem_by_id** — Update the attributes of a workitem. (PATCH /api/v2/taskmanagement/workitems/{workitemId}) Requires any of permissions workitems:workitem:edit, workitems:workitem:accept. The id is the workitemId. Required: id.
- **create_taskmanagement_worktype_flow_datebased_rule** — Add a date based rule to a worktype. (POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules) Requires permission workitems:flowRuleDateBased:add. Required: worktype_id, name, condition.
- **delete_taskmanagement_worktype_flow_datebased_rule_by_id** — Delete a date based rule. (DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}) Requires permission workitems:flowRuleDateBased:delete. The id is the ruleId. Required: id, worktype_id.
- **get_taskmanagement_worktype_flow_datebased_rule_by_id** — Get a date based rule. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}) Requires permission workitems:flowRuleDateBased:view. The id is the ruleId. Required: id, worktype_id.
- **list_all_taskmanagement_worktype_flow_datebased_rules** — Get all date based rules for a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules) Requires permission workitems:flowRuleDateBased:view. Pages automatically: pass the returned next_cursor to get the next page. Required: worktype_id.
- **update_taskmanagement_worktype_flow_datebased_rule_by_id** — Update the attributes of a date based rule. (PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId}) Requires permission workitems:flowRuleDateBased:edit. The id is the ruleId. Required: id, worktype_id.
- **create_taskmanagement_worktype_flow_onattributechange_rule** — Add an attribute-change rule to a worktype. (POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules) Requires permission workitems:flowRuleOnAttributeChange:add. Required: worktype_id, name.
- **delete_taskmanagement_worktype_flow_onattributechange_rule_by_id** — Delete a rule. (DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}) Requires permission workitems:flowRuleOnAttributeChange:delete. The id is the ruleId. Required: id, worktype_id.
- **get_taskmanagement_worktype_flow_onattributechange_rule_by_id** — Get an attribute change rule. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}) Requires permission workitems:flowRuleOnAttributeChange:view. The id is the ruleId. Required: id, worktype_id.
- **list_all_taskmanagement_worktype_flow_onattributechange_rules** — Get all attribute-change rules for a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules) Requires permission workitems:flowRuleOnAttributeChange:view. Pages automatically: pass the returned next_cursor to get the next page. Required: worktype_id.
- **update_taskmanagement_worktype_flow_onattributechange_rule_by_id** — Update the attributes of a rule. (PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}) Requires permission workitems:flowRuleOnAttributeChange:edit. The id is the ruleId. Required: id, worktype_id.
- **create_taskmanagement_worktype_flow_oncreate_rule** — Add an on-create rule to a worktype. (POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules) Requires permission workitems:flowRuleOnCreate:add. Required: worktype_id, name.
- **delete_taskmanagement_worktype_flow_oncreate_rule_by_id** — Delete a rule. (DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}) Requires permission workitems:flowRuleOnCreate:delete. The id is the ruleId. Required: id, worktype_id.
- **get_taskmanagement_worktype_flow_oncreate_rule_by_id** — Get an on-create rule. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}) Requires permission workitems:flowRuleOnCreate:view. The id is the ruleId. Required: id, worktype_id.
- **list_all_taskmanagement_worktype_flow_oncreate_rules** — Get all on-create rules for a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules) Requires permission workitems:flowRuleOnCreate:view. Pages automatically: pass the returned next_cursor to get the next page. Required: worktype_id.
- **update_taskmanagement_worktype_flow_oncreate_rule_by_id** — Update the attributes of a rule. (PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}) Requires permission workitems:flowRuleOnCreate:edit. The id is the ruleId. Required: id, worktype_id.
- **list_all_genesys_cloud_taskmanagement_worktype_history** — Get a listing of a worktype's attribute change history. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/history) Requires permission workitems:worktype:view. Pages automatically: pass the returned next_cursor to get the next page. Required: worktype_id.
- **create_a_genesys_cloud_taskmanagement_worktype_status** — Add a status to a worktype. (POST /api/v2/taskmanagement/worktypes/{worktypeId}/statuses) Requires permission workitems:status:add. Required: worktype_id, name, category.
- **delete_a_genesys_cloud_taskmanagement_worktype_status_by_id** — Delete a status. (DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}) Requires permission workitems:status:delete. The id is the statusId. Required: id, worktype_id.
- **get_single_genesys_cloud_taskmanagement_worktype_status_by_id** — Get a status. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}) Requires permission workitems:status:view. The id is the statusId. Required: id, worktype_id.
- **list_all_genesys_cloud_taskmanagement_worktype_statuses** — Get list of statuses for this worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses) Requires permission workitems:status:view. Required: worktype_id.
- **update_a_genesys_cloud_taskmanagement_worktype_status_by_id** — Update the attributes of a status. (PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}) Requires permission workitems:status:edit. The id is the statusId. Required: id, worktype_id.
- **get_single_genesys_cloud_taskmanagement_worktype_version_by_id** — Get a version of a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion}) Requires permission workitems:worktype:view. The id is the entityVersion. Required: id, worktype_id.
- **list_all_genesys_cloud_taskmanagement_worktype_versions** — Get all versions of a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}/versions) Requires permission workitems:worktype:view. Pages automatically: pass the returned next_cursor to get the next page. Required: worktype_id.
- **create_a_genesys_cloud_taskmanagement_worktype** — Create a worktype. (POST /api/v2/taskmanagement/worktypes) Requires permission workitems:worktype:add. Required: name, defaultWorkbinId.
- **delete_a_genesys_cloud_taskmanagement_worktype_by_id** — Delete a worktype. (DELETE /api/v2/taskmanagement/worktypes/{worktypeId}) Requires permission workitems:worktype:delete. The id is the worktypeId. Required: id.
- **get_single_genesys_cloud_taskmanagement_worktype_by_id** — Get a worktype. (GET /api/v2/taskmanagement/worktypes/{worktypeId}) Requires permission workitems:worktype:view. The id is the worktypeId. Required: id.
- **genesys_cloud_taskmanagement_worktypes_search** — Query for worktypes. Optional request field 'expands' may include 'schema' to populate the name on each worktype's schema reference. (POST /api/v2/taskmanagement/worktypes/query) Requires permission workitems:worktype:view. Required: filters.
- **update_a_genesys_cloud_taskmanagement_worktype_by_id** — Update the attributes of a worktype. (PATCH /api/v2/taskmanagement/worktypes/{worktypeId}) Requires permission workitems:worktype:edit. The id is the worktypeId. Required: id.
- **genesys_cloud_team_members_bulk_delete** — Delete team members. (DELETE /api/v2/teams/{teamId}/members) Requires permission groups:team:assign. Required: team_id, id.
- **create_a_genesys_cloud_team_member** — Add team members. (POST /api/v2/teams/{teamId}/members) Requires permission groups:team:assign. Required: team_id, memberIds.
- **list_all_genesys_cloud_team_members** — Get team membership. (GET /api/v2/teams/{teamId}/members) Requires permission groups:team:view. Pages automatically: pass the returned next_cursor to get the next page. Required: team_id.
- **create_a_genesys_cloud_team** — Create a team. (POST /api/v2/teams) Requires permission groups:team:add. Required: name.
- **delete_a_genesys_cloud_team_by_id** — Delete team. (DELETE /api/v2/teams/{teamId}) Requires permission groups:team:delete. The id is the teamId. Required: id.
- **get_single_genesys_cloud_team_by_id** — Get team. (GET /api/v2/teams/{teamId}) Requires permission groups:team:view. The id is the teamId. Required: id.
- **list_all_genesys_cloud_teams** — Get Team listing. (GET /api/v2/teams) Requires permission groups:team:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_teams_search** — Search resources. (POST /api/v2/teams/search) Requires permission groups:team:view. Required: query.
- **update_a_genesys_cloud_team_by_id** — Update team. (PATCH /api/v2/teams/{teamId}) Requires permission groups:team:edit. The id is the teamId. Required: id.
- **genesys_cloud_telephony_agent_greeting_me_bulk_update** — Updates the agent's own greetings. (PUT /api/v2/telephony/agents/greetings/me) Requires permission telephony:selfAgentGreeting:edit.
- **genesys_cloud_telephony_agent_greeting_me_lookup** — Get the agent's own greetings. (GET /api/v2/telephony/agents/greetings/me) Requires permission telephony:selfAgentGreeting:view.
- **genesys_cloud_telephony_agent_greetings_bulk_update** — Updates an agent's greetings. (PUT /api/v2/telephony/agents/{agentId}/greetings) Requires permission telephony:otherAgentGreeting:edit. Required: agent_id.
- **genesys_cloud_telephony_agent_greetings_lookup** — Get an agent's greetings. (GET /api/v2/telephony/agents/{agentId}/greetings) Requires permission telephony:otherAgentGreeting:view. Required: agent_id.
- **genesys_cloud_telephony_call_metrics_lookup** — Get the concurrent call metrics for a given organization. (GET /api/v2/telephony/calls/metrics) Requires permission telephony:callMetrics:view.
- **genesys_cloud_telephony_mediaregions_lookup** — Retrieve the list of AWS regions media can stream through. (GET /api/v2/telephony/mediaregions) Requires permission telephony:plugin:all.
- **create_a_genesys_cloud_telephony_number_routing** — Update the routing of numbers for one or multiple organizations. (POST /api/v2/telephony/numbers/routing) Requires permission telephony:numberRouting:edit.
- **list_all_genesys_cloud_telephony_number_routing** — Get Number Routings by organizationId. (GET /api/v2/telephony/numbers/routing) Requires permission telephony:numberRouting:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_telephony_number_routing_reset** — Reset routing for organization. (POST /api/v2/telephony/numbers/routing/reset) Requires permission telephony:numberRouting:edit. Required: resetOrganizationId.
- **create_a_genesys_cloud_telephony_number_routing_all** — Re-route all numbers on an organization. (POST /api/v2/telephony/numbers/routing/all) Requires permission telephony:numberRouting:edit. Required: sourceOrganizationId, switchOrganizationId, targetRegion.
- **create_a_genesys_cloud_telephony_organization_link** — Create a link with an organization. (POST /api/v2/telephony/organization/link) Requires permission telephony:organizationLink:add. Required: targetOrganizationId, targetRegion.
- **delete_a_genesys_cloud_telephony_organization_link_by_id** — Delete a link. (DELETE /api/v2/telephony/organization/link/{targetOrganizationId}) Requires permission telephony:organizationLink:delete. The id is the targetOrganizationId. Required: id.
- **list_all_genesys_cloud_telephony_organization_link** — Get organization links. (GET /api/v2/telephony/organization/link) Requires permission telephony:organizationLink:view.
- **update_a_genesys_cloud_telephony_organization_link_approve_by_id** — Approving a requested link. (PATCH /api/v2/telephony/organization/link/approve/{requestingOrganizationId}) Requires permission telephony:organizationLink:edit. The id is the requestingOrganizationId. Required: id, approval.
- **list_all_genesys_cloud_telephony_organization_link_regions** — Get all the replica regions by primary region. (GET /api/v2/telephony/organization/link/regions) Requires permission telephony:organizationLink:view.
- **create_a_genesys_cloud_telephony_prefix_bulk** — Bulk save prefixes. (POST /api/v2/telephony/prefixes/bulk) Requires permission telephony:prefix:add. Required: entities.
- **genesys_cloud_telephony_prefix_simulate_call_lookup** — Simulate call to test fraud prefix functionality. (GET /api/v2/telephony/prefixes/simulate/call) Requires permission telephony:prefix:view. Required: number.
- **list_all_genesys_cloud_telephony_prefixes** — Get prefixes. (GET /api/v2/telephony/prefixes) Requires permission telephony:prefix:view. Pages automatically: pass the returned next_cursor to get the next page. Required: type.
- **create_a_genesys_cloud_telephony_provider_edge_addressvalidation** — Validates a street address. (POST /api/v2/telephony/providers/edges/addressvalidation)
- **telephony_provider_edge_alertablepresences_bulk_delete** — Deletes alertable presences overrides. (DELETE /api/v2/telephony/providers/edges/alertablepresences) Requires permission telephony:alertablePresences:delete.
- **telephony_provider_edge_alertablepresences_bulk_update** — Creates or updates alertable presences overrides. (PUT /api/v2/telephony/providers/edges/alertablepresences) Requires permission telephony:alertablePresences:edit. Required: alertablePresences.
- **list_all_telephony_provider_edge_alertablepresences** — Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no…. (GET /api/v2/telephony/providers/edges/alertablepresences) Requires permission telephony:alertablePresences:view.
- **create_telephony_provider_edge_certificateauthority** — Create a certificate authority. (POST /api/v2/telephony/providers/edges/certificateauthorities) Requires permission telephony:plugin:all. Required: name, certificate, type, services.
- **delete_telephony_provider_edge_certificateauthority_by_id** — Delete a certificate authority. (DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}) Requires permission telephony:plugin:all. The id is the certificateId. Required: id.
- **get_telephony_provider_edge_certificateauthority_by_id** — Get a certificate authority. (GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}) Requires permission telephony:plugin:all. The id is the certificateId. Required: id.
- **list_all_telephony_provider_edge_certificateauthorities** — Get the list of certificate authorities. (GET /api/v2/telephony/providers/edges/certificateauthorities) Requires permission telephony:plugin:all.
- **update_telephony_provider_edge_certificateauthority_by_id** — Update a certificate authority. (PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId}) Requires permission telephony:plugin:all. The id is the certificateId. Required: id, name, certificate, type, services.
- **create_telephony_provider_edge_diagnostic_nslookup** — Nslookup request command to collect networking-related information from an Edge for a target IP or host. (POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup) Requires permission telephony:plugin:all. Required: edge_id, host.
- **genesys_cloud_telephony_provider_edge_diagnostic_nslookup_lookup** — Get networking-related information from an Edge for a target IP or host. (GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup) Requires permission telephony:plugin:all. Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_diagnostic_ping** — Ping Request command to collect networking-related information from an Edge for a target IP or host. (POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping) Requires permission telephony:plugin:all. Required: edge_id, host.
- **genesys_cloud_telephony_provider_edge_diagnostic_ping_lookup** — Get networking-related information from an Edge for a target IP or host. (GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping) Requires permission telephony:plugin:all. Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_diagnostic_route** — Route request command to collect networking-related information from an Edge for a target IP or host. (POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route) Requires permission telephony:plugin:all. Required: edge_id, host.
- **genesys_cloud_telephony_provider_edge_diagnostic_route_lookup** — Get networking-related information from an Edge for a target IP or host. (GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route) Requires permission telephony:plugin:all. Required: edge_id.
- **create_telephony_provider_edge_diagnostic_tracepath** — Tracepath request command to collect networking-related information from an Edge for a target IP or host. (POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath) Requires permission telephony:plugin:all. Required: edge_id, host.
- **telephony_provider_edge_diagnostic_tracepath_lookup** — Get networking-related information from an Edge for a target IP or host. (GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath) Requires permission telephony:plugin:all. Required: edge_id.
- **list_all_genesys_cloud_telephony_provider_edge_didpool_dids** — Get a listing of unassigned and/or assigned numbers in a set of DID Pools. (GET /api/v2/telephony/providers/edges/didpools/dids) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize. Required: type.
- **create_a_genesys_cloud_telephony_provider_edge_didpool** — Create a new DID pool. (POST /api/v2/telephony/providers/edges/didpools) Requires permission telephony:plugin:all. Required: name, startPhoneNumber, endPhoneNumber.
- **delete_a_genesys_cloud_telephony_provider_edge_didpool_by_id** — Delete a DID Pool by ID. (DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId}) Requires permission telephony:plugin:all. The id is the didPoolId. Required: id.
- **get_single_genesys_cloud_telephony_provider_edge_didpool_by_id** — Get a DID Pool by ID. (GET /api/v2/telephony/providers/edges/didpools/{didPoolId}) Requires permission telephony:plugin:all. The id is the didPoolId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_didpools** — Get a listing of DID Pools. (GET /api/v2/telephony/providers/edges/didpools) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_telephony_provider_edge_didpool_by_id** — Update a DID Pool by ID. (PUT /api/v2/telephony/providers/edges/didpools/{didPoolId}) Requires permission telephony:plugin:all. The id is the didPoolId. Required: id, name, startPhoneNumber, endPhoneNumber.
- **get_single_genesys_cloud_telephony_provider_edge_did_by_id** — Get a DID by ID. (GET /api/v2/telephony/providers/edges/dids/{didId}) Requires permission telephony:plugin:all. The id is the didId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_dids** — Get a listing of DIDs. (GET /api/v2/telephony/providers/edges/dids) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **get_telephony_provider_edge_edgegroup_edgetrunkbase_by_id** — Gets the edge trunk base associated with the edge group. (GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}) Requires permission telephony:plugin:all. The id is the edgetrunkbaseId. Required: id, edgegroup_id.
- **update_telephony_provider_edge_edgegroup_edgetrunkbase_by_id** — Update the edge trunk base associated with the edge group. (PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId}) Requires permission telephony:plugin:all. The id is the edgetrunkbaseId. Required: id, edgegroup_id, name, trunkMetabase, trunkType.
- **create_a_genesys_cloud_telephony_provider_edge_edgegroup** — Create an edge group. (POST /api/v2/telephony/providers/edges/edgegroups) Requires permission telephony:plugin:all. Required: name, edgeTrunkBaseAssignment, phoneTrunkBases.
- **delete_a_genesys_cloud_telephony_provider_edge_edgegroup_by_id** — Delete an edge group. (DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}) Requires permission telephony:plugin:all. The id is the edgeGroupId. Required: id.
- **get_single_genesys_cloud_telephony_provider_edge_edgegroup_by_id** — Get edge group. (GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}) Requires permission telephony:plugin:all. The id is the edgeGroupId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_edgegroups** — Get the list of edge groups. (GET /api/v2/telephony/providers/edges/edgegroups) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_telephony_provider_edge_edgegroup_by_id** — Update an edge group. (PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId}) Requires permission telephony:plugin:all. The id is the edgeGroupId. Required: id, name, edgeTrunkBaseAssignment, phoneTrunkBases.
- **genesys_cloud_telephony_provider_edge_edgeversionreport_lookup** — Get the edge version report. The report will not have consistent data about the edge version(s) until all edges have been reset. (GET /api/v2/telephony/providers/edges/edgeversionreport)
- **list_all_genesys_cloud_telephony_provider_edge_expired** — List of edges more than 4 edge versions behind the latest software. (GET /api/v2/telephony/providers/edges/expired) Requires any of permissions telephony:plugin:all, internal:edge:view.
- **list_all_telephony_provider_edge_extensionpool_divisionviews** — Get a pageable list of basic extension pool objects filterable by query parameters. This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch extension pools that match the given ID(s) and not use any additional supplied query parameters in the search. (GET /api/v2/telephony/providers/edges/extensionpools/divisionviews) Requires permission telephony:extensionPool:search. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_telephony_provider_edge_extensionpool** — Create a new extension pool. (POST /api/v2/telephony/providers/edges/extensionpools) Requires permission telephony:extensionPool:add. Required: name.
- **delete_telephony_provider_edge_extensionpool_by_id** — Delete an extension pool by ID. (DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}) Requires permission telephony:extensionPool:delete. The id is the extensionPoolId. Required: id.
- **get_telephony_provider_edge_extensionpool_by_id** — Get an extension pool by ID. (GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}) Requires permission telephony:extensionPool:view. The id is the extensionPoolId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_extensionpools** — Get a listing of extension pools. (GET /api/v2/telephony/providers/edges/extensionpools) Requires permission telephony:extensionPool:view. Pages automatically with pageNumber/pageSize.
- **update_telephony_provider_edge_extensionpool_by_id** — Update an extension pool by ID. (PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId}) Requires permission telephony:extensionPool:edit. The id is the extensionPoolId. Required: id, name.
- **get_single_genesys_cloud_telephony_provider_edge_extension_by_id** — Get an extension by ID. (GET /api/v2/telephony/providers/edges/extensions/{extensionId}) Requires permission telephony:extensionPool:view. The id is the extensionId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_extensions** — Get a listing of extensions. (GET /api/v2/telephony/providers/edges/extensions) Requires permission telephony:extensionPool:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_telephony_provider_edge_line_template_lookup** — Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance. (GET /api/v2/telephony/providers/edges/lines/template) Requires permission telephony:plugin:all. Required: lineBaseSettingsId.
- **get_telephony_provider_edge_linebasesetting_by_id** — Get a line base settings object by ID. (GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}) Requires permission telephony:plugin:all. The id is the lineBaseId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_linebasesettings** — Get a listing of line base settings objects. (GET /api/v2/telephony/providers/edges/linebasesettings) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **get_single_genesys_cloud_telephony_provider_edge_line_by_id** — Get a Line by ID. (GET /api/v2/telephony/providers/edges/lines/{lineId}) Requires permission telephony:plugin:all. The id is the lineId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_lines** — Get a list of Lines. (GET /api/v2/telephony/providers/edges/lines) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_telephony_provider_edge_log_job_upload** — Request that the specified fileIds be uploaded from the Edge. (POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload) Requires permission telephony:plugin:all. Required: edge_id, job_id, fileIds.
- **create_a_genesys_cloud_telephony_provider_edge_log_job** — Create a job to upload a list of Edge logs. (POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs) Requires permission telephony:plugin:all. Required: edge_id.
- **get_single_genesys_cloud_telephony_provider_edge_log_job_by_id** — Get an Edge logs job. (GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}) Requires permission telephony:plugin:all. The id is the jobId. Required: id, edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_logicalinterface** — Create an edge logical interface. Create. (POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces) Requires permission telephony:plugin:all. Required: edge_id, name, friendlyName, hardwareAddress, physicalAdapterId.
- **delete_telephony_provider_edge_logicalinterface_by_id** — Delete an edge logical interface. (DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}) Requires permission telephony:plugin:all. The id is the interfaceId. Required: id, edge_id.
- **get_telephony_provider_edge_logicalinterface_by_id** — Get an edge logical interface. (GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}) Requires permission telephony:plugin:all. The id is the interfaceId. Required: id, edge_id.
- **list_all_genesys_cloud_telephony_provider_edge_logicalinterfaces** — Get edge logical interfaces. Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time. (GET /api/v2/telephony/providers/edges/logicalinterfaces) Requires permission telephony:plugin:all. Required: edgeIds.
- **update_telephony_provider_edge_logicalinterface_by_id** — Update an edge logical interface. (PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId}) Requires permission telephony:plugin:all. The id is the interfaceId. Required: id, edge_id, name, friendlyName, hardwareAddress, physicalAdapterId.
- **list_all_telephony_provider_edge_logicalinterfaces_by_edge** — Get edge logical interfaces. Retrieve a list of all configured logical interfaces from a specific edge. (GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces) Requires permission telephony:plugin:all. Required: edge_id.
- **list_all_genesys_cloud_telephony_provider_edge_metrics** — Get the metrics for a list of edges. (GET /api/v2/telephony/providers/edges/metrics) Requires permission telephony:plugin:all. Required: edgeIds.
- **genesys_cloud_telephony_provider_edge_metrics_lookup** — Get the edge metrics. (GET /api/v2/telephony/providers/edges/{edgeId}/metrics) Requires permission telephony:plugin:all. Required: edge_id.
- **create_telephony_provider_edge_offlineconfiguration** — Create a file that can be used to configure a hardware Edge's settings. (POST /api/v2/telephony/providers/edges/{edgeId}/offlineconfiguration) Requires permission telephony:plugin:all. Required: edge_id, pairingId, network.
- **list_all_genesys_cloud_telephony_provider_edge_outboundroutes** — Get outbound routes. (GET /api/v2/telephony/providers/edges/outboundroutes) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **create_a_genesys_cloud_telephony_provider_edge_phone_reboot** — Reboot Multiple Phones. (POST /api/v2/telephony/providers/edges/phones/reboot) Requires permission telephony:plugin:all.
- **create_telephony_provider_edge_phone_reboot_by_phone** — Reboot a Phone. (POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot) Requires permission telephony:plugin:all. Required: phone_id.
- **genesys_cloud_telephony_provider_edge_phone_template_lookup** — Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance. (GET /api/v2/telephony/providers/edges/phones/template) Requires permission telephony:plugin:all. Required: phoneBaseSettingsId.
- **create_a_genesys_cloud_telephony_provider_edge_phonebasesetting** — Create a new Phone Base Settings object. (POST /api/v2/telephony/providers/edges/phonebasesettings) Requires permission telephony:plugin:all. Required: name, phoneMetaBase, lines.
- **delete_telephony_provider_edge_phonebasesetting_by_id** — Delete a Phone Base Settings by ID. (DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}) Requires permission telephony:plugin:all. The id is the phoneBaseId. Required: id.
- **get_telephony_provider_edge_phonebasesetting_by_id** — Get a Phone Base Settings object by ID. (GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}) Requires permission telephony:plugin:all. The id is the phoneBaseId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_phonebasesettings** — Get a list of Phone Base Settings objects. (GET /api/v2/telephony/providers/edges/phonebasesettings) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **update_telephony_provider_edge_phonebasesetting_by_id** — Update a Phone Base Settings by ID. (PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}) Requires permission telephony:plugin:all. The id is the phoneBaseId. Required: id, name, phoneMetaBase, lines.
- **list_all_telephony_provider_edge_phonebasesettings_metabases** — Get a list of available makes and models to create a new Phone Base Settings. (GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **telephony_provider_edge_phonebasesettings_template_lookup** — Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance. (GET /api/v2/telephony/providers/edges/phonebasesettings/template) Requires permission telephony:plugin:all. Required: phoneMetabaseId.
- **create_a_genesys_cloud_telephony_provider_edge_phone** — Create a new Phone. (POST /api/v2/telephony/providers/edges/phones) Requires permission telephony:plugin:all. Required: name, site, phoneBaseSettings, lines.
- **delete_a_genesys_cloud_telephony_provider_edge_phone_by_id** — Delete a Phone by ID. (DELETE /api/v2/telephony/providers/edges/phones/{phoneId}) Requires permission telephony:plugin:all. The id is the phoneId. Required: id.
- **get_single_genesys_cloud_telephony_provider_edge_phone_by_id** — Get a Phone by ID. (GET /api/v2/telephony/providers/edges/phones/{phoneId}) Requires permission telephony:plugin:all. The id is the phoneId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_phones** — Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. (GET /api/v2/telephony/providers/edges/phones) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_telephony_provider_edge_phone_by_id** — Update a Phone by ID. (PUT /api/v2/telephony/providers/edges/phones/{phoneId}) Requires permission telephony:plugin:all. The id is the phoneId. Required: id, name, site, phoneBaseSettings, lines.
- **get_telephony_provider_edge_physicalinterface_by_id** — Get edge physical interface. Retrieve a physical interface from a specific edge. (GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId}) Requires permission telephony:plugin:all. The id is the interfaceId. Required: id, edge_id.
- **list_all_telephony_provider_edge_physicalinterfaces** — Get physical interfaces for edges. Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time. (GET /api/v2/telephony/providers/edges/physicalinterfaces) Requires permission telephony:plugin:all. Required: edgeIds.
- **list_all_telephony_provider_edge_physicalinterfaces_by_edge** — Retrieve a list of all configured physical interfaces from a specific edge. (GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces) Requires permission telephony:plugin:all. Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_reboot** — Reboot an Edge. (POST /api/v2/telephony/providers/edges/{edgeId}/reboot) Requires permission telephony:plugin:all. Required: edge_id.
- **genesys_cloud_telephony_provider_edge_setuppackage_lookup** — Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. (GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage) Requires permission telephony:plugin:all. Required: edge_id.
- **list_all_telephony_provider_edge_site_numberplan_classifications** — Get a list of Classifications for this Site. (GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications) Requires permission telephony:plugin:all. Required: site_id.
- **telephony_provider_edge_site_numberplans_bulk_update** — Update the list of Number Plans. A user can update maximum 200 number plans at a time. (PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans) Requires permission telephony:plugin:all. Required: site_id.
- **get_telephony_provider_edge_site_numberplan_by_id** — Get a Number Plan by ID. (GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId}) Requires permission telephony:plugin:all. The id is the numberPlanId. Required: id, site_id.
- **list_all_genesys_cloud_telephony_provider_edge_site_numberplans** — Get the list of Number Plans for this Site. Only fetches the first 200 records. (GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans) Requires permission telephony:plugin:all. Required: site_id.
- **create_telephony_provider_edge_site_outboundroute** — Create outbound route. (POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes) Requires permission telephony:plugin:all. Required: site_id, name, classificationTypes.
- **delete_telephony_provider_edge_site_outboundroute_by_id** — Delete Outbound Route. (DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}) Requires permission telephony:plugin:all. The id is the outboundRouteId. Required: id, site_id.
- **get_telephony_provider_edge_site_outboundroute_by_id** — Get an outbound route. (GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}) Requires permission telephony:plugin:all. The id is the outboundRouteId. Required: id, site_id.
- **list_all_telephony_provider_edge_site_outboundroutes** — Get outbound routes. (GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize. Required: site_id.
- **update_telephony_provider_edge_site_outboundroute_by_id** — Update outbound route. (PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId}) Requires permission telephony:plugin:all. The id is the outboundRouteId. Required: id, site_id, name, classificationTypes.
- **genesys_cloud_telephony_provider_edge_site_search_lookup** — Search sites using the q64 value returned from a previous search. (GET /api/v2/telephony/providers/edges/sites/search) Requires any of permissions telephony:plugin:all, telephony:sites:view. Required: q64.
- **telephony_provider_edge_site_siteconnections_bulk_partial_update** — Disable site connections for a site. (PATCH /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections) Requires permission telephony:plugin:all. Required: site_id.
- **telephony_provider_edge_site_siteconnections_bulk_update** — Update site connections for a site. (PUT /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections) Requires permission telephony:plugin:all. Required: site_id.
- **telephony_provider_edge_site_siteconnections_lookup** — Get site connections for a site. (GET /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections) Requires any of permissions telephony:plugin:all, telephony:sites:view. Required: site_id.
- **create_a_genesys_cloud_telephony_provider_edge_site** — Create a Site. (POST /api/v2/telephony/providers/edges/sites) Requires permission telephony:plugin:all. Required: name, location.
- **delete_a_genesys_cloud_telephony_provider_edge_site_by_id** — Delete a Site by ID. (DELETE /api/v2/telephony/providers/edges/sites/{siteId}) Requires permission telephony:plugin:all. The id is the siteId. Required: id.
- **get_single_genesys_cloud_telephony_provider_edge_site_by_id** — Get a Site by ID. (GET /api/v2/telephony/providers/edges/sites/{siteId}) Requires any of permissions telephony:plugin:all, telephony:sites:view. The id is the siteId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_sites** — Get the list of Sites. (GET /api/v2/telephony/providers/edges/sites) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_telephony_provider_edge_sites_search** — Search sites. (POST /api/v2/telephony/providers/edges/sites/search) Requires any of permissions telephony:plugin:all, telephony:sites:view.
- **update_a_genesys_cloud_telephony_provider_edge_site_by_id** — Update a Site by ID. (PUT /api/v2/telephony/providers/edges/sites/{siteId}) Requires permission telephony:plugin:all. The id is the siteId. Required: id, name, location.
- **genesys_cloud_telephony_provider_edge_softwareupdate_bulk_delete** — Cancels any in-progress update for this edge. (DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate) Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_softwareupdate** — Starts a software update for this edge. (POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate) Required: edge_id, version.
- **genesys_cloud_telephony_provider_edge_softwareupdate_lookup** — Gets software update status information about any edge. (GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate) Required: edge_id.
- **list_all_genesys_cloud_telephony_provider_edge_softwareversions** — Gets all the available software versions for this edge. (GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions) Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge_statuscode** — Take an Edge in or out of service. (POST /api/v2/telephony/providers/edges/{edgeId}/statuscode) Requires permission telephony:plugin:all. Required: edge_id, inService.
- **list_all_genesys_cloud_telephony_provider_edge_timezones** — Get a list of Edge-compatible time zones. (GET /api/v2/telephony/providers/edges/timezones) Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_telephony_provider_edge_trunk_metrics** — Get the metrics for a list of trunks. (GET /api/v2/telephony/providers/edges/trunks/metrics) Requires permission telephony:plugin:all. Required: trunkIds.
- **genesys_cloud_telephony_provider_edge_trunk_metrics_lookup** — Get the trunk metrics. (GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics) Requires permission telephony:plugin:all. Required: trunk_id.
- **create_a_genesys_cloud_telephony_provider_edge_trunkbasesetting** — Create a Trunk Base Settings object. (POST /api/v2/telephony/providers/edges/trunkbasesettings) Requires permission telephony:plugin:all. Required: name, trunkMetabase, trunkType.
- **delete_telephony_provider_edge_trunkbasesetting_by_id** — Delete a Trunk Base Settings object by ID. (DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}) Requires permission telephony:plugin:all. The id is the trunkBaseSettingsId. Required: id.
- **get_telephony_provider_edge_trunkbasesetting_by_id** — Get a Trunk Base Settings object by ID. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. (GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}) Requires permission telephony:plugin:all. The id is the trunkBaseSettingsId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_trunkbasesettings** — Get Trunk Base Settings listing. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. (GET /api/v2/telephony/providers/edges/trunkbasesettings) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_telephony_provider_edge_trunkbasesettings_search** — Search Trunk Base Settings. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. (POST /api/v2/telephony/providers/edges/trunkbasesettings/search) Requires permission telephony:plugin:all.
- **update_telephony_provider_edge_trunkbasesetting_by_id** — Update a Trunk Base Settings object by ID. (PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}) Requires permission telephony:plugin:all. The id is the trunkBaseSettingsId. Required: id, name, trunkMetabase, trunkType.
- **list_all_telephony_provider_edge_trunkbasesettings_metabases** — Get a list of available makes and models to create a new Trunk Base Settings. (GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **get_telephony_provider_edge_trunkbasesettings_site_by_id** — Get Trunk Base Settings listing for site. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission. (GET /api/v2/telephony/providers/edges/trunkbasesettings/site/{siteId}) Requires permission telephony:plugin:all. The id is the siteId. Required: id.
- **telephony_provider_edge_trunkbasesettings_template_lookup** — Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance. (GET /api/v2/telephony/providers/edges/trunkbasesettings/template) Requires permission telephony:plugin:all. Required: trunkMetabaseId.
- **get_single_genesys_cloud_telephony_provider_edge_trunk_by_id** — Get a Trunk by ID. (GET /api/v2/telephony/providers/edges/trunks/{trunkId}) Requires permission telephony:plugin:all. The id is the trunkId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edge_trunks** — Get the list of available trunks. Trunks are created by assigning trunk base settings to an Edge or Edge Group. (GET /api/v2/telephony/providers/edges/trunks) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_telephony_provider_edge_trunks_search** — Search for trunks. (POST /api/v2/telephony/providers/edges/trunks/search) Requires permission telephony:plugin:all.
- **list_all_genesys_cloud_telephony_provider_edge_trunks_by_edge** — Get the list of available trunks for the given Edge. Trunks are created by assigning trunk base settings to an Edge or Edge Group. (GET /api/v2/telephony/providers/edges/{edgeId}/trunks) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize. Required: edge_id.
- **genesys_cloud_telephony_provider_edge_trunkswithrecording_lookup** — Get Counts of trunks that have recording disabled or enabled. (GET /api/v2/telephony/providers/edges/trunkswithrecording) Requires any of permissions recording:retentionPolicy:view, telephony:plugin:all.
- **create_a_genesys_cloud_telephony_provider_edge_unpair** — Unpair an Edge. (POST /api/v2/telephony/providers/edges/{edgeId}/unpair) Requires permission telephony:plugin:all. Required: edge_id.
- **create_a_genesys_cloud_telephony_provider_edge** — Create an edge. (POST /api/v2/telephony/providers/edges) Requires permission telephony:plugin:all. Required: name.
- **delete_a_genesys_cloud_telephony_provider_edge_by_id** — Delete a edge. (DELETE /api/v2/telephony/providers/edges/{edgeId}) Requires permission telephony:plugin:all. The id is the edgeId. Required: id.
- **get_single_genesys_cloud_telephony_provider_edge_by_id** — Get edge. (GET /api/v2/telephony/providers/edges/{edgeId}) Requires permission telephony:plugin:all. The id is the edgeId. Required: id.
- **list_all_genesys_cloud_telephony_provider_edges** — Get the list of edges. (GET /api/v2/telephony/providers/edges) Requires permission telephony:plugin:all. Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_telephony_provider_edge_by_id** — Update a edge. (PUT /api/v2/telephony/providers/edges/{edgeId}) Requires permission telephony:plugin:all. The id is the edgeId. Required: id, name.
- **genesys_cloud_telephony_settings_bulk_update** — Update the global telephony configuration. (PUT /api/v2/telephony/settings) Requires permission telephony:settings:edit.
- **genesys_cloud_telephony_settings_lookup** — Get the global telephony configuration. (GET /api/v2/telephony/settings) Requires permission telephony:settings:view.
- **genesys_cloud_telephony_sipmessage_conversation_headers_lookup** — Get SIP headers. Get parsed SIP headers. Returns specific headers if key query parameters are added. (GET /api/v2/telephony/sipmessages/conversations/{conversationId}/headers) Requires permission telephony:pcap:view. Required: conversation_id.
- **get_single_genesys_cloud_telephony_sipmessage_conversation_by_id** — Get a SIP message. Get the raw form of the SIP message. (GET /api/v2/telephony/sipmessages/conversations/{conversationId}) Requires permission telephony:pcap:view. The id is the conversationId. Required: id.
- **create_a_genesys_cloud_telephony_siptrace_download** — Request a download of a pcap file to S3. (POST /api/v2/telephony/siptraces/download) Requires permission telephony:pcap:add. Required: dateStart, dateEnd.
- **get_single_genesys_cloud_telephony_siptrace_download_by_id** — Get signed S3 URL for a pcap download. (GET /api/v2/telephony/siptraces/download/{downloadId}) Requires permission telephony:pcap:view. The id is the downloadId. Required: id.
- **genesys_cloud_telephony_siptraces_lookup** — Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. (GET /api/v2/telephony/siptraces) Requires permission telephony:pcap:view. Required: dateStart, dateEnd.
- **list_all_genesys_cloud_telephony_trunkbasesettings_metrics** — Get the trunkbase metrics for the specified ids. (GET /api/v2/telephony/trunkbasesettings/metrics) Requires permission telephony:plugin:all. Required: ids.
- **genesys_cloud_telephony_trunkbasesettings_metrics_lookup** — Get the trunkbase metrics. (GET /api/v2/telephony/trunkbasesettings/{trunkBaseId}/metrics) Requires permission telephony:plugin:all. Required: trunk_base_id.
- **list_all_genesys_cloud_textbot_bot_search** — Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100. (GET /api/v2/textbots/bots/search) Requires permission integrations:integration:view.
- **create_a_genesys_cloud_textbot_botflow_session_turn** — Issue a bot flow turn event. Send a turn event to an executing bot flow and produce the next action to take. (POST /api/v2/textbots/botflows/sessions/{sessionId}/turns) Requires permission textbots:botFlowSession:execute. Required: session_id, inputEventType.
- **create_a_genesys_cloud_textbot_botflow_session** — Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'. (POST /api/v2/textbots/botflows/sessions) Requires permission textbots:botFlowSession:execute. Required: flow, externalSessionId, channel.
- **genesys_cloud_textbot_bots_execute** — Send an intent to a bot to start a dialog/interact with it via text. This will either start a bot with the given id or relay a communication to an existing bot session. (POST /api/v2/textbots/bots/execute) Requires permission textbots:session:execute. Required: botId, integrationId, botSessionId, postTextMessage.
- **list_all_genesys_cloud_timezones** — Get time zones list. (GET /api/v2/timezones) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_token_me_bulk_delete** — Delete auth token used to make the request. (DELETE /api/v2/tokens/me)
- **genesys_cloud_token_me_lookup** — Fetch information about the current token. (GET /api/v2/tokens/me)
- **genesys_cloud_token_timeout_bulk_update** — Update or Enable/Disable the Idle Token Timeout. (PUT /api/v2/tokens/timeout) Requires permission directory:organization:admin.
- **genesys_cloud_token_timeout_lookup** — Get the current Idle Token Timeout Value. (GET /api/v2/tokens/timeout)
- **delete_a_genesys_cloud_token_by_id** — Delete all auth tokens for the specified user. (DELETE /api/v2/tokens/{userId}) Requires permission oauth:token:delete. The id is the userId. Required: id.
- **create_a_genesys_cloud_upload_learning_coverart** — Generates pre-signed URL to upload cover art for learning modules. (POST /api/v2/uploads/learning/coverart) Requires permission learning:coverart:upload. Required: contentType.
- **create_a_genesys_cloud_upload_publicasset_image** — Creates presigned url for uploading a public asset image. (POST /api/v2/uploads/publicassets/images) Requires permission uploads:publicasset:upload.
- **create_a_genesys_cloud_upload_recording** — Creates presigned url for uploading a recording file. (POST /api/v2/uploads/recordings) Requires permission recording:recording:upload.
- **create_a_genesys_cloud_upload_wfm_historicaldata_csv** — Creates presigned url for uploading WFM historical data file. Requires data in csv format. (POST /api/v2/uploads/workforcemanagement/historicaldata/csv) Requires permission wfm:historicalData:upload.
- **create_a_genesys_cloud_usage_aggregate_query_job** — Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results. (POST /api/v2/usage/aggregates/query/jobs) Requires permission usage:organization:view. Required: interval.
- **get_single_genesys_cloud_usage_aggregate_query_job_by_id** — Get the status and results of the usage query. (GET /api/v2/usage/aggregates/query/jobs/{jobId}) Requires permission usage:organization:view. The id is the jobId. Required: id.
- **create_a_genesys_cloud_usage_client_aggregate_query_job** — Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results. (POST /api/v2/usage/client/{clientId}/aggregates/query/jobs) Requires permission usage:client:view. Required: client_id, interval.
- **get_single_genesys_cloud_usage_client_aggregate_query_job_by_id** — Get the status and results of the usage query. (GET /api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}) Requires permission usage:client:view. The id is the jobId. Required: id, client_id.
- **genesys_cloud_usage_event_aggregates_search** — Get aggregates for operational events in a timeframe. (POST /api/v2/usage/events/aggregates/query) Requires permission usage:events:view. Required: interval.
- **get_single_genesys_cloud_usage_event_definition_by_id** — Get an operational event definition by its id. (GET /api/v2/usage/events/definitions/{eventDefinitionId}) Requires permission usage:events:view. The id is the eventDefinitionId. Required: id.
- **list_all_genesys_cloud_usage_event_definitions** — Get all operational event definitions. (GET /api/v2/usage/events/definitions) Requires permission usage:events:view.
- **genesys_cloud_usage_events_search** — Query operational events in a timeframe. (POST /api/v2/usage/events/query) Requires permission usage:events:view. Required: interval.
- **genesys_cloud_user_adjacents_lookup** — Get adjacents. (GET /api/v2/users/{userId}/adjacents) Required: user_id.
- **genesys_cloud_user_agentui_agent_autoanswer_settings_bulk_delete** — Delete agent auto answer settings. (DELETE /api/v2/users/agentui/agents/autoanswer/{agentId}/settings) Requires permission agentUI:agents:delete. Required: agent_id.
- **user_agentui_agent_autoanswer_settings_bulk_partial_update** — Update agent auto answer settings. (PATCH /api/v2/users/agentui/agents/autoanswer/{agentId}/settings) Requires permission agentUI:agents:edit. Required: agent_id.
- **genesys_cloud_user_agentui_agent_autoanswer_settings_bulk_update** — Set agent auto answer settings. (PUT /api/v2/users/agentui/agents/autoanswer/{agentId}/settings) Requires permission agentUI:agents:edit. Required: agent_id, settings.
- **genesys_cloud_user_agentui_agent_autoanswer_settings_lookup** — Get agent auto answer settings. (GET /api/v2/users/agentui/agents/autoanswer/{agentId}/settings) Requires permission agentUI:agents:view. Required: agent_id.
- **genesys_cloud_user_bulk_bulk_partial_update** — Update bulk acd autoanswer on users. Max 50 users can be updated at a time. (PATCH /api/v2/users/bulk) Requires any of permissions directory:user:edit, directory:organization:admin.
- **genesys_cloud_user_callforwarding_bulk_partial_update** — Patch a user's CallForwarding. (PATCH /api/v2/users/{userId}/callforwarding) Requires permission conversation:callForwarding:edit. Required: user_id.
- **genesys_cloud_user_callforwarding_bulk_update** — Update a user's CallForwarding. (PUT /api/v2/users/{userId}/callforwarding) Requires permission conversation:callForwarding:edit. Required: user_id.
- **genesys_cloud_user_callforwarding_lookup** — Get a user's CallForwarding. (GET /api/v2/users/{userId}/callforwarding) Requires permission conversation:callForwarding:view. Required: user_id.
- **list_all_genesys_cloud_user_chat_me** — Get chats for a user. (GET /api/v2/users/chats/me) Requires any of permissions chat:chat:access, user:chats:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_user_customattribute_bulk_bulk_partial_update** — Update multiple custom attributes records by amending the data with only the provided fields. (PATCH /api/v2/users/{userId}/customattributes/bulk) Requires permission directory:user:edit. Required: user_id.
- **list_all_genesys_cloud_user_customattribute_bulk** — Get multiple custom attributes records by schema ids. (GET /api/v2/users/{userId}/customattributes/bulk) Requires permission directory:user:view. Required: user_id, schemaIds.
- **get_user_customattribute_schema_coretype_by_id** — Get the core types from which all schemas are built. (GET /api/v2/users/customattributes/schemas/coretypes/{coreTypeName}) Requires permission users:customAttributesSchema:view. The id is the coreTypeName. Required: id.
- **list_all_genesys_cloud_user_customattribute_schema_coretypes** — Get the list of core types enabled for a specific namespace. (GET /api/v2/users/customattributes/schemas/coretypes) Requires permission users:customAttributesSchema:view.
- **genesys_cloud_user_customattribute_schema_limits_lookup** — Get quantitative limits on schemas. (GET /api/v2/users/customattributes/schemas/limits) Requires permission users:customAttributesSchema:view.
- **get_user_customattribute_schema_version_by_id** — Get a specific version of a schema. (GET /api/v2/users/customattributes/schemas/{schemaId}/versions/{versionId}) Requires permission users:customAttributesSchema:view. The id is the versionId. Required: id, schema_id.
- **list_all_genesys_cloud_user_customattribute_schema_versions** — Get all versions of a user schema. (GET /api/v2/users/customattributes/schemas/{schemaId}/versions) Requires permission users:customAttributesSchema:view. Required: schema_id.
- **create_a_genesys_cloud_user_customattribute_schema** — Create a schema. (POST /api/v2/users/customattributes/schemas) Requires permission users:customAttributesSchema:add. Required: version, jsonSchema.
- **delete_a_genesys_cloud_user_customattribute_schema_by_id** — Delete a schema. (DELETE /api/v2/users/customattributes/schemas/{schemaId}) Requires permission users:customAttributesSchema:delete. The id is the schemaId. Required: id.
- **get_single_genesys_cloud_user_customattribute_schema_by_id** — Get a schema. (GET /api/v2/users/customattributes/schemas/{schemaId}) Requires permission users:customAttributesSchema:view. The id is the schemaId. Required: id.
- **list_all_genesys_cloud_user_customattribute_schemas** — Get a list of schemas. (GET /api/v2/users/customattributes/schemas) Requires permission users:customAttributesSchema:view.
- **update_a_genesys_cloud_user_customattribute_schema_by_id** — Update a schema. (PUT /api/v2/users/customattributes/schemas/{schemaId}) Requires permission users:customAttributesSchema:edit. The id is the schemaId. Required: id, version, jsonSchema.
- **genesys_cloud_user_customattributes_bulk_partial_update** — Update a single custom attributes record by amending the data with only the provided fields. (PATCH /api/v2/users/{userId}/customattributes) Requires permission directory:user:edit. Required: user_id.
- **genesys_cloud_user_customattributes_bulk_update** — Create or update a single custom attributes record. Updating replaces all data with the provided fields. (PUT /api/v2/users/{userId}/customattributes) Requires permission directory:user:edit. Required: user_id, attributes.
- **delete_a_genesys_cloud_user_customattribute_by_id** — Delete a custom attributes record. (DELETE /api/v2/users/{userId}/customattributes/{schemaId}) Requires permission directory:user:edit. The id is the schemaId. Required: id, user_id.
- **get_single_genesys_cloud_user_customattribute_by_id** — Get custom attributes by schema id. (GET /api/v2/users/{userId}/customattributes/{schemaId}) Requires permission directory:user:view. The id is the schemaId. Required: id, user_id.
- **get_single_genesys_cloud_user_development_activity_by_id** — Get a Development Activity. Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment. (GET /api/v2/users/development/activities/{activityId}) Requires any of permissions learning:assignment:view, coaching:appointment:view. The id is the activityId. Required: id, type.
- **list_all_genesys_cloud_user_development_activities** — Get list of Development Activities. Either moduleId or userId is required. Results are filtered based on the applicable permissions. (GET /api/v2/users/development/activities) Requires any of permissions learning:assignment:view, coaching:appointment:view. Pages automatically with pageNumber/pageSize.
- **genesys_cloud_user_development_activity_aggregates_search** — Retrieve aggregated development activity data. Results are filtered based on the applicable permissions. (POST /api/v2/users/development/activities/aggregates/query) Requires any of permissions learning:assignment:view, coaching:appointment:view. Required: interval, filter.
- **list_all_genesys_cloud_user_development_activity_me** — Get list of Development Activities for current user. Results are filtered based on the applicable permissions. (GET /api/v2/users/development/activities/me) Pages automatically with pageNumber/pageSize.
- **list_all_genesys_cloud_user_directreports** — Get direct reports. (GET /api/v2/users/{userId}/directreports) Required: user_id.
- **create_a_genesys_cloud_user_externalid** — Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive. (POST /api/v2/users/{userId}/externalid) Requires permission directory:user:edit. Required: user_id, authorityName, externalKey.
- **delete_a_genesys_cloud_user_externalid_by_id** — Delete the external identifier for user. (DELETE /api/v2/users/{userId}/externalid/{authorityName}/{externalKey}) Requires permission directory:user:edit. The id is the externalKey. Required: id, user_id, authority_name.
- **get_single_genesys_cloud_user_externalid_by_id** — Get the user associated with external identifier. Authority name and external key are case sensitive. (GET /api/v2/users/externalid/{authorityName}/{externalKey}) The id is the externalKey. Required: id, authority_name.
- **list_all_genesys_cloud_user_externalid** — Get the external identifiers for a user. (GET /api/v2/users/{userId}/externalid) Required: user_id.
- **get_single_genesys_cloud_user_externalid_by_user_by_id** — Get the external identifier of user for an authority. Authority name and external key are case sensitive. (GET /api/v2/users/{userId}/externalid/{authorityName}) The id is the authorityName. Required: id, user_id.
- **get_single_genesys_cloud_user_geolocation_by_id** — Get a user's Geolocation. (GET /api/v2/users/{userId}/geolocations/{clientId}) The id is the clientId. Required: id, user_id.
- **update_a_genesys_cloud_user_geolocation_by_id** — Patch a user's Geolocation. The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. (PATCH /api/v2/users/{userId}/geolocations/{clientId}) The id is the clientId. Required: id, user_id.
- **genesys_cloud_user_greeting_defaults_bulk_update** — Updates the DefaultGreetingList of the specified User. (PUT /api/v2/users/{userId}/greetings/defaults) Required: user_id.
- **genesys_cloud_user_greeting_defaults_lookup** — Grabs the list of Default Greetings given a User's ID. (GET /api/v2/users/{userId}/greetings/defaults) Required: user_id.
- **create_a_genesys_cloud_user_greeting** — Creates a Greeting for a User. (POST /api/v2/users/{userId}/greetings) Required: user_id, type, ownerType, owner.
- **list_all_genesys_cloud_user_greetings** — Get a list of the User's Greetings. (GET /api/v2/users/{userId}/greetings) Pages automatically with pageNumber/pageSize. Required: user_id.
- **genesys_cloud_user_me_lookup** — Get current user details. This request is not valid when using the Client Credentials OAuth grant. (GET /api/v2/users/me)
- **create_a_genesys_cloud_user_me_password** — Change your password. (POST /api/v2/users/me/password) Required: newPassword, oldPassword.
- **create_a_genesys_cloud_user_me_verifier_totp** — Add a new TOTP verifier. (POST /api/v2/users/me/verifiers/totp) Required: name.
- **create_a_genesys_cloud_user_me_verifier_totp_post** — Validate a TOTP verifier. (POST /api/v2/users/me/verifiers/totp/{verifierId}) Required: verifier_id, token.
- **create_a_genesys_cloud_user_me_verifier_webauthn_register** — Finish WebAuthn verifier registration. Completes registration of a new WebAuthn authenticator by submitting the credential creation response produced by navigator.credentials.create(). (POST /api/v2/users/me/verifiers/webauthn/register) Required: credential, name.
- **create_a_genesys_cloud_user_me_verifier_webauthn_register_option** — Begin WebAuthn verifier registration. Returns the public key credential creation options the client passes to navigator.credentials.create() to start registering a new WebAuthn authenticator. (POST /api/v2/users/me/verifiers/webauthn/register/options)
- **delete_a_genesys_cloud_user_me_verifier_by_id** — Delete a verifier. (DELETE /api/v2/users/me/verifiers/{verifierId}) The id is the verifierId. Required: id.
- **list_all_genesys_cloud_user_me_verifiers** — Get a list of my verifiers. (GET /api/v2/users/me/verifiers)
- **update_a_genesys_cloud_user_me_verifier_by_id** — Update a verifier. (PUT /api/v2/users/me/verifiers/{verifierId}) The id is the verifierId. Required: id, name.
- **genesys_cloud_user_outofoffice_bulk_update** — Update an OutOfOffice. (PUT /api/v2/users/{userId}/outofoffice) Required: user_id.
- **genesys_cloud_user_outofoffice_lookup** — Get a OutOfOffice. (GET /api/v2/users/{userId}/outofoffice) Required: user_id.
- **create_a_genesys_cloud_user_password** — Change a users password. (POST /api/v2/users/{userId}/password) Requires permission directory:user:setPassword. Required: user_id, newPassword.
- **genesys_cloud_user_presence_bulk_bulk_update** — Update bulk user Presences. (PUT /api/v2/users/presences/bulk) Requires permission presence:userPresence:edit.
- **list_all_genesys_cloud_user_presence_bulk** — Get bulk user presences for a single presence source. (GET /api/v2/users/presences/{sourceId}/bulk) Required: source_id.
- **genesys_cloud_user_presence_purecloud_bulk_partial_update** — Patch a Genesys Cloud user's presence. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. (PATCH /api/v2/users/{userId}/presences/purecloud) Required: user_id.
- **genesys_cloud_user_presence_purecloud_lookup** — Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD. (GET /api/v2/users/{userId}/presences/purecloud) Required: user_id.
- **list_all_genesys_cloud_user_presence_purecloud_bulk** — Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source. (GET /api/v2/users/presences/purecloud/bulk)
- **get_single_genesys_cloud_user_presence_by_id** — Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources. (GET /api/v2/users/{userId}/presences/{sourceId}) The id is the sourceId. Required: id, user_id.
- **update_a_genesys_cloud_user_presence_by_id** — Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. (PATCH /api/v2/users/{userId}/presences/{sourceId}) The id is the sourceId. Required: id, user_id.
- **genesys_cloud_user_profileskills_bulk_update** — Update profile skills for a user. (PUT /api/v2/users/{userId}/profileskills) Requires permission directory:userProfile:edit. Required: user_id.
- **list_all_genesys_cloud_user_profileskills** — List profile skills for a user. (GET /api/v2/users/{userId}/profileskills) Requires permission directory:userProfile:view. Required: user_id.
- **genesys_cloud_user_query_lookup** — Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required. (GET /api/v2/users/query) Requires permission directory:user:view.
- **genesys_cloud_user_queues_bulk_partial_update** — Join or unjoin a set of queues for a user. Users can only be joined to queues where they have membership. Non-member user-queue pairs in the request will be disregarded. Note: This operation is processed asynchronously and the response data may not reflect the final state. Changes may take time to propagate. (PATCH /api/v2/users/{userId}/queues) Requires any of permissions routing:queue:join, routing:queueMember:manage. Required: user_id.
- **list_all_genesys_cloud_user_queues** — Get queues for user. (GET /api/v2/users/{userId}/queues) Requires permission routing:queue:view. Pages automatically with pageNumber/pageSize. Required: user_id.
- **update_a_genesys_cloud_user_queue_by_id** — Join or unjoin a queue for a user. (PATCH /api/v2/users/{userId}/queues/{queueId}) Requires any of permissions routing:queue:join, routing:queueMember:manage. The id is the queueId. Required: id, user_id.
- **genesys_cloud_user_roles_bulk_update** — Sets the user's roles. (PUT /api/v2/users/{subjectId}/roles) Requires permission authorization:grant:add. Required: subject_id.
- **genesys_cloud_user_roles_lookup** — Returns a listing of roles and permissions for a user. (GET /api/v2/users/{subjectId}/roles) Requires permission authorization:grant:view. Required: subject_id.
- **genesys_cloud_user_routinglanguage_bulk_bulk_partial_update** — Assign multiple routing languages to a user. Max 50 routing languages in request body. (PATCH /api/v2/users/{userId}/routinglanguages/bulk) Requires any of permissions routing:skill:assign, routing:language:assign. Required: user_id.
- **create_a_genesys_cloud_user_routinglanguage** — Assign a routing language to a user. (POST /api/v2/users/{userId}/routinglanguages) Requires any of permissions routing:skill:assign, routing:language:assign. Required: user_id, id, proficiency.
- **delete_a_genesys_cloud_user_routinglanguage_by_id** — Remove a routing language from a user. (DELETE /api/v2/users/{userId}/routinglanguages/{languageId}) Requires any of permissions routing:skill:assign, routing:language:assign. The id is the languageId. Required: id, user_id.
- **list_all_genesys_cloud_user_routinglanguages** — List routing languages assigned to a user. (GET /api/v2/users/{userId}/routinglanguages) Pages automatically with pageNumber/pageSize. Required: user_id.
- **update_a_genesys_cloud_user_routinglanguage_by_id** — Update an assigned routing language's proficiency. (PATCH /api/v2/users/{userId}/routinglanguages/{languageId}) Requires any of permissions routing:skill:assign, routing:language:assign. The id is the languageId. Required: id, user_id.
- **genesys_cloud_user_routingskill_bulk_bulk_partial_update** — Assign multiple routing skills to a user. (PATCH /api/v2/users/{userId}/routingskills/bulk) Requires permission routing:skill:assign. Required: user_id.
- **genesys_cloud_user_routingskill_bulk_bulk_update** — Assign multiple routing skills to a user, replacing any current assignments. (PUT /api/v2/users/{userId}/routingskills/bulk) Requires permission routing:skill:assign. Required: user_id.
- **create_a_genesys_cloud_user_routingskill** — Assign a routing skill to a user. (POST /api/v2/users/{userId}/routingskills) Requires permission routing:skill:assign. Required: user_id, id, proficiency.
- **delete_a_genesys_cloud_user_routingskill_by_id** — Remove a routing skill from a user. (DELETE /api/v2/users/{userId}/routingskills/{skillId}) Requires permission routing:skill:assign. The id is the skillId. Required: id, user_id.
- **list_all_genesys_cloud_user_routingskills** — List routing skills assigned to a user. (GET /api/v2/users/{userId}/routingskills) Pages automatically with pageNumber/pageSize. Required: user_id.
- **update_a_genesys_cloud_user_routingskill_by_id** — Update an assigned routing skill's proficiency. (PUT /api/v2/users/{userId}/routingskills/{skillId}) Requires permission routing:skill:assign. The id is the skillId. Required: id, user_id.
- **genesys_cloud_user_routingstatus_bulk_update** — Update the routing status of a user. (PUT /api/v2/users/{userId}/routingstatus) Required: user_id.
- **genesys_cloud_user_routingstatus_lookup** — Fetch the routing status of a user. (GET /api/v2/users/{userId}/routingstatus) Required: user_id.
- **get_single_genesys_cloud_user_rule_dependent_by_id** — Get dependent of a users rule. (GET /api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}) Requires permission users:ruleDependents:view. The id is the typeId. Required: id, rule_id, rule_type.
- **list_all_genesys_cloud_user_rule_dependents** — Get dependents for a users rule. (GET /api/v2/users/rules/{ruleId}/dependents) Requires permission users:ruleDependents:view. Pages automatically with pageNumber/pageSize. Required: rule_id.
- **get_single_genesys_cloud_user_rule_setting_by_id** — Get the settings for a specific users rule type. (GET /api/v2/users/rules/settings/{ruleType}) Requires permission users:rules:view. The id is the ruleType. Required: id.
- **create_a_genesys_cloud_user_rule** — Create a new rule. This will create a new rule with the specified fields. (POST /api/v2/users/rules) Requires permission users:rules:add. Required: name, type, criteria.
- **delete_a_genesys_cloud_user_rule_by_id** — Delete an existing users rule. (DELETE /api/v2/users/rules/{ruleId}) Requires permission users:rules:delete. The id is the ruleId. Required: id.
- **get_single_genesys_cloud_user_rule_by_id** — Get a users rule. (GET /api/v2/users/rules/{ruleId}) Requires permission users:rules:view. The id is the ruleId. Required: id.
- **list_all_genesys_cloud_user_rules** — Get the list of users rules. (GET /api/v2/users/rules) Requires permission users:rules:view. Pages automatically with pageNumber/pageSize. Required: types.
- **genesys_cloud_user_rules_search** — Query the result of a users rule. This will query the result of a rule. (POST /api/v2/users/rules/query) Requires permission users:ruleUsers:view. Required: type, criteria, userIds.
- **update_a_genesys_cloud_user_rule_by_id** — Update an existing users rule. This will update an existing users rule with the specified fields. (PATCH /api/v2/users/rules/{ruleId}) Requires permission users:rules:edit. The id is the ruleId. Required: id.
- **create_a_genesys_cloud_user_screenmonitor_session** — Start an agent-level screen monitoring session. (POST /api/v2/users/{userId}/screenmonitors/sessions) Requires permission realtimeMonitor:screen:monitorAgent. Required: user_id.
- **delete_a_genesys_cloud_user_screenmonitor_session_by_id** — Stop an agent-level screen monitoring session. (DELETE /api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}) Requires permission realtimeMonitor:screen:monitorAgent. The id is the screenMonitoringId. Required: id, user_id.
- **get_single_genesys_cloud_user_screenmonitor_session_by_id** — Get an agent-level screen monitoring session object using the supplied screenMonitoringId. (GET /api/v2/users/{userId}/screenmonitors/sessions/{screenMonitoringId}) Requires permission realtimeMonitor:screen:monitorAgent. The id is the screenMonitoringId. Required: id, user_id.
- **genesys_cloud_user_search_lookup** — Search users using the q64 value returned from a previous search. (GET /api/v2/users/search) Requires permission directory:user:view. Required: q64.
- **genesys_cloud_user_search_teams_assign** — Search users assigned to teams. (POST /api/v2/users/search/teams/assign) Requires permission groups:team:assign.
- **list_all_genesys_cloud_user_skillgroups** — Get skill groups for a user. (GET /api/v2/users/{userId}/skillgroups) Requires permission routing:skillGroup:view. Pages automatically: pass the returned next_cursor to get the next page. Required: user_id.
- **genesys_cloud_user_state_bulk_update** — Update user state information. (PUT /api/v2/users/{userId}/state) Requires permission directory:user:edit. Required: user_id.
- **genesys_cloud_user_state_lookup** — Get user state information. (GET /api/v2/users/{userId}/state) Requires permission directory:userStateChange:view. Required: user_id.
- **genesys_cloud_user_station_lookup** — Get station information for user. (GET /api/v2/users/{userId}/station) Requires permission telephony:otherStationAssociation:view. Required: user_id.
- **genesys_cloud_user_station_associatedstation_bulk_delete** — Clear associated station. (DELETE /api/v2/users/{userId}/station/associatedstation) Requires permission telephony:station:disassociate. Required: user_id.
- **update_a_genesys_cloud_user_station_associatedstation_by_id** — Set associated station. (PUT /api/v2/users/{userId}/station/associatedstation/{stationId}) Requires permission telephony:otherStationAssociation:edit. The id is the stationId. Required: id, user_id.
- **genesys_cloud_user_station_defaultstation_bulk_delete** — Clear default station. (DELETE /api/v2/users/{userId}/station/defaultstation) Requires any of permissions telephony:plugin:all, telephony:phone:assign. Required: user_id.
- **update_a_genesys_cloud_user_station_defaultstation_by_id** — Set default station. (PUT /api/v2/users/{userId}/station/defaultstation/{stationId}) Requires any of permissions telephony:plugin:all, telephony:phone:assign. The id is the stationId. Required: id, user_id.
- **genesys_cloud_user_station_me_lookup** — Get station information for self. (GET /api/v2/users/stations/me) Requires permission telephony:selfStationAssociation:view.
- **genesys_cloud_user_station_me_associatedstation_bulk_delete** — Clear self associated station. (DELETE /api/v2/users/stations/me/associatedstation) Requires permission telephony:station:disassociateSelf.
- **update_a_genesys_cloud_user_station_me_associatedstation_by_id** — Set self associated station. (PUT /api/v2/users/stations/me/associatedstation/{stationId}) Requires permission telephony:selfStationAssociation:edit. The id is the stationId. Required: id.
- **list_all_genesys_cloud_user_superiors** — Get superiors. (GET /api/v2/users/{userId}/superiors) Required: user_id.
- **list_all_genesys_cloud_user_trustors** — List the organizations that have authorized/trusted the user. (GET /api/v2/users/{userId}/trustors) Requires permission authorization:orgTrustor:view. Pages automatically with pageNumber/pageSize. Required: user_id.
- **delete_a_genesys_cloud_user_verifier_by_id** — Delete a verifier. (DELETE /api/v2/users/{userId}/verifiers/{verifierId}) Requires permission mfa:verifier:delete. The id is the verifierId. Required: id, user_id.
- **get_single_genesys_cloud_user_verifier_by_id** — Get a verifier. (GET /api/v2/users/{userId}/verifiers/{verifierId}) Requires permission mfa:verifier:view. The id is the verifierId. Required: id, user_id.
- **list_all_genesys_cloud_user_verifiers** — Get a list of verifiers. (GET /api/v2/users/{userId}/verifiers) Requires permission mfa:verifier:view. Required: user_id.
- **update_a_genesys_cloud_user_verifier_by_id** — Update a verifier. (PUT /api/v2/users/{userId}/verifiers/{verifierId}) Requires permission mfa:verifier:edit. The id is the verifierId. Required: id, user_id, name.
- **genesys_cloud_userrecording_summary_lookup** — Get user recording summary. (GET /api/v2/userrecordings/summary)
- **genesys_cloud_userrecording_transcoding_lookup** — Download a user recording. (GET /api/v2/userrecordings/{recordingId}/transcoding) Requires permission They are enforced by the backend. Required: recording_id.
- **delete_a_genesys_cloud_userrecording_by_id** — Delete a user recording. (DELETE /api/v2/userrecordings/{recordingId}) The id is the recordingId. Required: id.
- **get_single_genesys_cloud_userrecording_by_id** — Get a user recording. (GET /api/v2/userrecordings/{recordingId}) The id is the recordingId. Required: id.
- **list_all_genesys_cloud_userrecordings** — Get a list of user recordings. (GET /api/v2/userrecordings) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_userrecording_by_id** — Update a user recording. (PUT /api/v2/userrecordings/{recordingId}) The id is the recordingId. Required: id.
- **create_a_genesys_cloud_user** — Create user. If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration. (POST /api/v2/users) Requires permission directory:user:add. Required: name, email, divisionId.
- **delete_a_genesys_cloud_user_by_id** — Delete user. (DELETE /api/v2/users/{userId}) Requires any of permissions admin, directory:user:delete, directory:user:hardDelete, directory:organization:admin. The id is the userId. Required: id.
- **get_single_genesys_cloud_user_by_id** — Get user. (GET /api/v2/users/{userId}) The id is the userId. Required: id.
- **genesys_cloud_users_invite** — Send an activation email to the user. (POST /api/v2/users/{userId}/invite) Requires any of permissions admin, directory:organization:admin, directory:user:setPassword. Required: user_id.
- **list_all_genesys_cloud_users** — Get the list of available users. (GET /api/v2/users) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_users_search** — Search users. (POST /api/v2/users/search) Requires permission directory:user:view.
- **update_a_genesys_cloud_user_by_id** — Update user. Updating some fields, like a user's extension, requires the telephony:extension:assign permission for the relevant division. Without it, the request will return 403 Forbidden. (PATCH /api/v2/users/{userId}) Requires any of permissions admin, directory:user:edit, directory:organization:admin. The id is the userId. Required: id, version.
- **genesys_cloud_voicemail_search** — Search voicemails. (POST /api/v2/voicemail/search)
- **genesys_cloud_voicemail_group_mailbox_lookup** — Get the group's mailbox information. (GET /api/v2/voicemail/groups/{groupId}/mailbox) Required: group_id.
- **list_all_genesys_cloud_voicemail_group_messages** — List voicemail messages. (GET /api/v2/voicemail/groups/{groupId}/messages) Pages automatically with pageNumber/pageSize. Required: group_id.
- **genesys_cloud_voicemail_group_policy_bulk_partial_update** — Update a group's voicemail policy. (PATCH /api/v2/voicemail/groups/{groupId}/policy) Requires permission voicemail:groupPolicy:edit. Required: group_id.
- **genesys_cloud_voicemail_group_policy_lookup** — Get a group's voicemail policy. (GET /api/v2/voicemail/groups/{groupId}/policy) Requires permission voicemail:groupPolicy:view. Required: group_id.
- **genesys_cloud_voicemail_mailbox_lookup** — Get the current user's mailbox information. (GET /api/v2/voicemail/mailbox)
- **genesys_cloud_voicemail_me_mailbox_lookup** — Get the current user's mailbox information. (GET /api/v2/voicemail/me/mailbox)
- **list_all_genesys_cloud_voicemail_me_messages** — List voicemail messages. (GET /api/v2/voicemail/me/messages) Pages automatically with pageNumber/pageSize.
- **genesys_cloud_voicemail_me_policy_bulk_partial_update** — Update the current user's voicemail policy. (PATCH /api/v2/voicemail/me/policy)
- **genesys_cloud_voicemail_me_policy_lookup** — Get the current user's voicemail policy. (GET /api/v2/voicemail/me/policy)
- **genesys_cloud_voicemail_message_media_lookup** — Get media playback URI for this voicemail message. API should migrate to use GET api/v2/voicemail/messages/{messageId}/downloads. (GET /api/v2/voicemail/messages/{messageId}/media) Required: message_id.
- **genesys_cloud_voicemail_messages_bulk_delete** — Delete all voicemail messages. (DELETE /api/v2/voicemail/messages)
- **create_a_genesys_cloud_voicemail_message** — Copy a voicemail message to a user or group. (POST /api/v2/voicemail/messages) Required: voicemailMessageId.
- **delete_a_genesys_cloud_voicemail_message_by_id** — Delete a voicemail message. A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission. (DELETE /api/v2/voicemail/messages/{messageId}) The id is the messageId. Required: id.
- **get_single_genesys_cloud_voicemail_message_by_id** — Get a voicemail message. (GET /api/v2/voicemail/messages/{messageId}) The id is the messageId. Required: id.
- **list_all_genesys_cloud_voicemail_messages** — List voicemail messages. (GET /api/v2/voicemail/messages)
- **genesys_cloud_voicemail_messages_partial_update** — Update a voicemail message. A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. (PATCH /api/v2/voicemail/messages/{messageId}) Required: message_id.
- **update_a_genesys_cloud_voicemail_message_by_id** — Update a voicemail message. A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with. (PUT /api/v2/voicemail/messages/{messageId}) The id is the messageId. Required: id.
- **genesys_cloud_voicemail_policy_bulk_update** — Update a policy. (PUT /api/v2/voicemail/policy) Requires permission telephony:plugin:all.
- **genesys_cloud_voicemail_policy_lookup** — Get a policy. (GET /api/v2/voicemail/policy) Requires permission telephony:plugin:all.
- **list_all_genesys_cloud_voicemail_queue_messages** — List voicemail messages. (GET /api/v2/voicemail/queues/{queueId}/messages) Requires permission voicemail:acdvoicemail:view. Pages automatically with pageNumber/pageSize. Required: queue_id.
- **genesys_cloud_voicemail_search_lookup** — Search voicemails using the q64 value returned from a previous search. (GET /api/v2/voicemail/search) Required: q64.
- **genesys_cloud_voicemail_user_mailbox_lookup** — Get a user's mailbox information. (GET /api/v2/voicemail/users/{userId}/mailbox) Requires permission voicemail:mailbox:viewOther. Required: user_id.
- **list_all_genesys_cloud_voicemail_user_messages** — List voicemail messages. (GET /api/v2/voicemail/users/{userId}/messages) Requires permission voicemail:voicemail:viewOther. Pages automatically with pageNumber/pageSize. Required: user_id.
- **get_single_genesys_cloud_voicemail_userpolicy_by_id** — Get a user's voicemail policy. (GET /api/v2/voicemail/userpolicies/{userId}) Requires any of permissions telephony:plugin:all, voicemail:userPolicy:viewOther. The id is the userId. Required: id.
- **genesys_cloud_voicemail_userpolicies_partial_update** — Update a user's voicemail policy. (PATCH /api/v2/voicemail/userpolicies/{userId}) Requires any of permissions telephony:plugin:all, voicemail:userPolicy:viewOther. Required: user_id.
- **update_a_genesys_cloud_voicemail_userpolicy_by_id** — Update a user's voicemail policy. (PUT /api/v2/voicemail/userpolicies/{userId}) Requires any of permissions telephony:plugin:all, voicemail:userPolicy:viewOther. The id is the userId. Required: id.
- **webdeployment_configuration_version_draft_bulk_update** — Update the configuration draft. (PUT /api/v2/webdeployments/configurations/{configurationId}/versions/draft) Requires permission webDeployments:configuration:edit. Required: configuration_id, name.
- **genesys_cloud_webdeployment_configuration_version_draft_lookup** — Get the configuration draft. (GET /api/v2/webdeployments/configurations/{configurationId}/versions/draft) Requires permission webDeployments:configuration:view. Required: configuration_id.
- **genesys_cloud_webdeployment_configuration_version_draft_publish** — Publish the configuration draft and create a new version. (POST /api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish) Requires permissions webDeployments:configuration:edit, webDeployments:configuration:add. Required: configuration_id.
- **get_webdeployment_configuration_version_by_id** — Get a configuration version. (GET /api/v2/webdeployments/configurations/{configurationId}/versions/{versionId}) Requires permission webDeployments:configuration:view. The id is the versionId. Required: id, configuration_id.
- **list_all_genesys_cloud_webdeployment_configuration_versions** — Get the versions of a configuration. (GET /api/v2/webdeployments/configurations/{configurationId}/versions) Requires permission webDeployments:configuration:view. Pages automatically: pass the returned next_cursor to get the next page. Required: configuration_id.
- **create_a_genesys_cloud_webdeployment_configuration** — Create a configuration draft. (POST /api/v2/webdeployments/configurations) Requires permission webDeployments:configuration:add. Required: name.
- **delete_a_genesys_cloud_webdeployment_configuration_by_id** — Delete all versions of a configuration. (DELETE /api/v2/webdeployments/configurations/{configurationId}) Requires permission webDeployments:configuration:delete. The id is the configurationId. Required: id.
- **list_all_genesys_cloud_webdeployment_configurations** — View configuration drafts. (GET /api/v2/webdeployments/configurations) Requires permission webDeployments:configuration:view. Pages automatically: pass the returned next_cursor to get the next page.
- **genesys_cloud_webdeployment_deployment_configurations_lookup** — Get active configuration for a given deployment. (GET /api/v2/webdeployments/deployments/{deploymentId}/configurations) Required: deployment_id.
- **webdeployment_deployment_identityresolution_bulk_update** — Update identity resolution settings for a deployment. (PUT /api/v2/webdeployments/deployments/{deploymentId}/identityresolution) Requires permissions webDeployments:deployment:edit, webDeployments:identityResolution:edit. Required: deployment_id, resolveIdentities.
- **genesys_cloud_webdeployment_deployment_identityresolution_lookup** — Get a deployment identity resolution setting. (GET /api/v2/webdeployments/deployments/{deploymentId}/identityresolution) Requires permissions webDeployments:deployment:view, webDeployments:identityResolution:view. Required: deployment_id.
- **create_a_genesys_cloud_webdeployment_deployment** — Create a deployment. (POST /api/v2/webdeployments/deployments) Requires permission webDeployments:deployment:add. Required: name, configuration.
- **delete_a_genesys_cloud_webdeployment_deployment_by_id** — Delete a deployment. (DELETE /api/v2/webdeployments/deployments/{deploymentId}) Requires permission webDeployments:deployment:delete. The id is the deploymentId. Required: id.
- **get_single_genesys_cloud_webdeployment_deployment_by_id** — Get a deployment. (GET /api/v2/webdeployments/deployments/{deploymentId}) Requires permission webDeployments:deployment:view. The id is the deploymentId. Required: id.
- **list_all_genesys_cloud_webdeployment_deployments** — Get deployments. (GET /api/v2/webdeployments/deployments) Requires permission webDeployments:deployment:view. Pages automatically: pass the returned next_cursor to get the next page.
- **update_a_genesys_cloud_webdeployment_deployment_by_id** — Update a deployment. (PUT /api/v2/webdeployments/deployments/{deploymentId}) Requires permission webDeployments:deployment:edit. The id is the deploymentId. Required: id, name, configuration.
- **list_all_genesys_cloud_wfm_adherence** — Get a list of UserScheduleAdherence records for the requested users. (GET /api/v2/workforcemanagement/adherence) Requires permission wfm:realtimeAdherence:view. Required: userId.
- **create_a_genesys_cloud_wfm_adherence_adjustment** — Submit an adherence adjustment for the current user. (POST /api/v2/workforcemanagement/adherence/adjustments) Requires permission wfm:agentAdherenceAdjustments:add. Required: reasonCodeId, startDate, lengthMinutes.
- **delete_a_genesys_cloud_wfm_adherence_adjustment_by_id** — Delete an adherence adjustment for the current user. (DELETE /api/v2/workforcemanagement/adherence/adjustments/{adjustmentId}) Requires permission wfm:agentAdherenceAdjustments:delete. The id is the adjustmentId. Required: id.
- **get_single_genesys_cloud_wfm_adherence_adjustment_by_id** — Get an adherence adjustment for the current user. (GET /api/v2/workforcemanagement/adherence/adjustments/{adjustmentId}) Requires permission wfm:agentAdherenceAdjustments:view. The id is the adjustmentId. Required: id.
- **genesys_cloud_wfm_adherence_adjustments_search** — Query adherence adjustments for the current user. (POST /api/v2/workforcemanagement/adherence/adjustments/query) Requires permission wfm:agentAdherenceAdjustments:view. Required: startDate, endDate.
- **update_a_genesys_cloud_wfm_adherence_adjustment_by_id** — Update an adherence adjustment for the current user. (PATCH /api/v2/workforcemanagement/adherence/adjustments/{adjustmentId}) Requires permission wfm:agentAdherenceAdjustments:edit. The id is the adjustmentId. Required: id, metadata.
- **get_single_genesys_cloud_wfm_adherence_explanation_job_by_id** — Query the status of an adherence explanation operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/adherence/explanations/jobs/{jobId}) The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_adherence_explanation** — Submit an adherence explanation for the current user. (POST /api/v2/workforcemanagement/adherence/explanations) Requires permission wfm:agentAdherenceExplanation:submit. Required: type, startDate, lengthMinutes.
- **get_single_genesys_cloud_wfm_adherence_explanation_by_id** — Get an adherence explanation for the current user. (GET /api/v2/workforcemanagement/adherence/explanations/{explanationId}) Requires permission wfm:agentAdherenceExplanation:submit. The id is the explanationId. Required: id.
- **genesys_cloud_wfm_adherence_explanations_search** — Query adherence explanations for the current user. (POST /api/v2/workforcemanagement/adherence/explanations/query) Requires permission wfm:agentAdherenceExplanation:submit. Required: startDate, endDate.
- **create_a_genesys_cloud_wfm_adherence_historical_bulk** — Request a historical adherence report in bulk. (POST /api/v2/workforcemanagement/adherence/historical/bulk) Requires permission wfm:historicalAdherence:view. Required: items, timeZone.
- **get_single_genesys_cloud_wfm_adherence_historical_bulk_job_by_id** — Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId}) The id is the jobId. Required: id.
- **get_single_genesys_cloud_wfm_adherence_historical_job_by_id** — Query the status of a historical adherence request operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/adherence/historical/jobs/{jobId}) Requires permission wfm:historicalAdherence:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_wfm_agent_adherence_adjustment_by_id** — Get an adherence adjustment for the requested agent. (GET /api/v2/workforcemanagement/agents/{agentId}/adherence/adjustments/{adjustmentId}) Requires permission wfm:adherenceAdjustments:view. The id is the adjustmentId. Required: id, agent_id.
- **genesys_cloud_wfm_agent_adherence_adjustments_search** — Query adherence adjustments for the requested agent. (POST /api/v2/workforcemanagement/agents/{agentId}/adherence/adjustments/query) Requires permission wfm:adherenceAdjustments:view. Required: agent_id, startDate, endDate.
- **update_a_genesys_cloud_wfm_agent_adherence_adjustment_by_id** — Update an adherence adjustment for the requested agent. (PATCH /api/v2/workforcemanagement/agents/{agentId}/adherence/adjustments/{adjustmentId}) Requires permission wfm:adherenceAdjustments:edit. The id is the adjustmentId. Required: id, agent_id, metadata.
- **create_a_genesys_cloud_wfm_agent_adherence_explanation** — Add an adherence explanation for the requested user. (POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations) Requires permission wfm:adherenceExplanation:add. Required: agent_id, type, startDate, lengthMinutes.
- **get_single_genesys_cloud_wfm_agent_adherence_explanation_by_id** — Get an adherence explanation. (GET /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}) Requires permission wfm:adherenceExplanation:view. The id is the explanationId. Required: id, agent_id.
- **genesys_cloud_wfm_agent_adherence_explanations_search** — Query adherence explanations for the given agent across a specified range. (POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query) Requires permission wfm:adherenceExplanation:view. Required: agent_id, startDate, endDate.
- **update_a_genesys_cloud_wfm_agent_adherence_explanation_by_id** — Update an adherence explanation. (PATCH /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId}) Requires permission wfm:adherenceExplanation:edit. The id is the explanationId. Required: id, agent_id.
- **genesys_cloud_wfm_agent_integration_hris_bulk_update** — Update integrations for agent. (PUT /api/v2/workforcemanagement/agents/{agentId}/integrations/hris) Requires permission wfm:agent:edit. Required: agent_id, associatedIntegrations.
- **genesys_cloud_wfm_agent_integration_hris_search** — Query integrations for agents. (POST /api/v2/workforcemanagement/agents/integrations/hris/query) Requires permission wfm:agent:view. Required: agentIds.
- **genesys_cloud_wfm_agent_managementunit_lookup** — Get the management unit to which the agent belongs. (GET /api/v2/workforcemanagement/agents/{agentId}/managementunit) Requires any of permissions wfm:agent:view, wfm:publishedSchedule:view, wfm:schedule:view, coaching:appointment:add …. Required: agent_id.
- **create_a_genesys_cloud_wfm_agent_me_adherence_historical_job** — Request an agent historical adherence report. The maximum supported range for historical adherence queries is 31 days, or 7 days when the expand query parameter includes any of the following: exceptionInfo, actuals, scheduledActivities. (POST /api/v2/workforcemanagement/agents/me/adherence/historical/jobs) Requires any of permissions wfm:agentHistoricalAdherence:view, wfm:agentHistoricalAdherenceConformance:view. Required: startDate.
- **get_wfm_agent_me_adherence_historical_job_by_id** — Request to fetch the status of the agent adherence job. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/agents/me/adherence/historical/jobs/{jobId}) The id is the jobId. Required: id.
- **genesys_cloud_wfm_agent_me_managementunit_lookup** — Get the management unit to which the currently logged in agent belongs. (GET /api/v2/workforcemanagement/agents/me/managementunit) Requires any of permissions wfm:agentSchedule:view, wfm:agentTimeOffRequest:submit, wfm:activityCode:add, wfm:activityCode:delete ….
- **create_a_genesys_cloud_wfm_agent_me_possibleworkshift** — Get agent possible work shifts for requested time frame. (POST /api/v2/workforcemanagement/agents/me/possibleworkshifts) Requires permission wfm:agentPossibleWorkShifts:view. Required: weekStartDate, weekCount.
- **genesys_cloud_wfm_agent_opportunities_search** — Query opportunities for the authenticated agent. Queries within the specified date range. Each opportunity includes the agent's enrollment details if they have enrolled. (POST /api/v2/workforcemanagement/agents/opportunities/query) Requires permission wfm:agentOpportunitiesQuery:view. Required: range.
- **create_a_genesys_cloud_wfm_agent_opportunity_enrollment_bulk_add** — Bulk add enrollments to opportunities for the authenticated agent. Allows an agent to enroll in opportunities. This endpoint can return partial success. (POST /api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add) Requires permission wfm:agentOpportunitiesEnrollments:add. Required: enrollments.
- **create_wfm_agent_opportunity_enrollment_bulk_statuse_update** — Bulk update enrollment status for the authenticated agent. Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated. (POST /api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update) Requires permission wfm:agentOpportunitiesEnrollmentsStatuses:edit. Required: enrollmentIds, status.
- **genesys_cloud_wfm_agent_unavailabletimes_bulk_partial_update** — Update unavailable times for the requested agent. Large requests will be partitioned into multiple internal processing batches. Validation will occur against each internal batch independently rather than against the final combined state represented by the entire request. (PATCH /api/v2/workforcemanagement/agents/{agentId}/unavailabletimes) Requires permission wfm:unavailableTimes:edit. Required: agent_id, entities.
- **genesys_cloud_wfm_agent_unavailabletimes_search** — Get agent unavailable times. (POST /api/v2/workforcemanagement/agents/{agentId}/unavailabletimes/query) Requires permission wfm:unavailableTimes:view. Required: agent_id, startDate, endDate.
- **create_a_genesys_cloud_wfm_agent** — Move agents in and out of management unit. (POST /api/v2/workforcemanagement/agents) Requires permission wfm:agent:edit. Required: userIds.
- **create_a_genesys_cloud_wfm_agentschedule_managementunit_mine** — Fetch agent schedules for the logged in user's management unit. (POST /api/v2/workforcemanagement/agentschedules/managementunits/mine) Requires permission wfm:agentManagementUnitSchedule:view. Required: startDate, endDate.
- **create_a_genesys_cloud_wfm_agentschedule_mine** — Get published schedule for the current user. (POST /api/v2/workforcemanagement/agentschedules/mine) Requires permission wfm:agentSchedule:view. Required: startDate, endDate.
- **create_a_genesys_cloud_wfm_alternativeshift_offer_job** — Request a list of alternative shift offers for a given schedule. (POST /api/v2/workforcemanagement/alternativeshifts/offers/jobs) Requires permission wfm:agentAlternativeShift:submit. Required: schedule, queryWeekDate.
- **get_single_genesys_cloud_wfm_alternativeshift_offer_job_by_id** — Query the status of an alternative shift offers operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}) Requires permission wfm:agentAlternativeShift:submit. The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_alternativeshift_offer_search_job** — Request a search of alternative shift offers for a given shift. (POST /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs) Requires permission wfm:agentAlternativeShift:submit. Required: schedule, queryWeekDate, initiatingShift.
- **get_wfm_alternativeshift_offer_search_job_by_id** — Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}) Requires permission wfm:agentAlternativeShift:submit. The id is the jobId. Required: id.
- **genesys_cloud_wfm_alternativeshift_settings_lookup** — Get alternative shifts settings from the current logged in agent’s business unit. (GET /api/v2/workforcemanagement/alternativeshifts/settings) Requires permission wfm:agentAlternativeShift:submit.
- **get_single_genesys_cloud_wfm_alternativeshift_trade_job_by_id** — Query the status of an alternative shift trades operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}) Requires permission wfm:agentAlternativeShift:submit. The id is the jobId. Required: id.
- **wfm_alternativeshift_trade_state_jobs_bulk_partial_update** — Bulk update alternative shift trade states. (PATCH /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs) Requires permission wfm:alternativeShift:edit. Required: managementUnitId.
- **get_wfm_alternativeshift_trade_state_job_by_id** — Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}) Requires permission wfm:alternativeShift:edit. The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_alternativeshift_trade** — Create my alternative shift trade using an existing offer's jobId. (POST /api/v2/workforcemanagement/alternativeshifts/trades) Requires permission wfm:agentAlternativeShift:submit. Required: jobId, alternativeShiftTradeGranularity.
- **get_single_genesys_cloud_wfm_alternativeshift_trade_by_id** — Get my alternative shift trade by trade ID. (GET /api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}) Requires permission wfm:agentAlternativeShift:submit. The id is the tradeId. Required: id.
- **genesys_cloud_wfm_alternativeshift_trades_lookup** — Get a list of my alternative shifts trades. (GET /api/v2/workforcemanagement/alternativeshifts/trades) Requires permission wfm:agentAlternativeShift:submit.
- **update_a_genesys_cloud_wfm_alternativeshift_trade_by_id** — Update my alternative shifts trade by trade ID. (PATCH /api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}) Requires permission wfm:agentAlternativeShift:submit. The id is the tradeId. Required: id, metadata.
- **create_wfm_bu_activityplan_occ_deletion_jobs_by_occurrence** — Delete an occurrence for the activity plan. Triggers a job to delete an occurrence of the activity plan. The activity plan cannot be updated until the job completes. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/deletions/jobs) Requires permission wfm:activityPlanOccurrenceDeletionJob:add. Required: business_unit_id, activity_plan_id, occurrence_id.
- **get_wfm_bu_activityplan_occ_deletion_jobs_by_occurrence_by_id** — Gets an occurrence deletion job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/deletions/jobs/{jobId}) Requires permission wfm:activityPlanOccurrenceDeletionJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id, occurrence_id.
- **create_wfm_bu_activityplan_occurrence_session_deletion_job** — Triggers a job to delete sessions for the activity plan occurrence. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/sessions/deletions/jobs) Requires permission wfm:activityPlanOccurrenceSessionDeletionJob:add. Required: business_unit_id, activity_plan_id, occurrence_id, ids.
- **get_wfm_bu_activityplan_occurrence_session_deletion_job_by_id** — Gets an activity plan sessions deletion job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/sessions/deletions/jobs/{jobId}) Requires permission wfm:activityPlanOccurrenceSessionDeletionJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id, occurrence_id.
- **create_wfm_bu_activityplan_occurrence_session_user_deletion_job** — Triggers a job to delete users from a session in the activity plan occurrence. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/sessions/{sessionId}/users/deletions/jobs) Requires permission wfm:activityPlanOccurrenceSessionUserDeletionJob:add. Required: business_unit_id, activity_plan_id, occurrence_id, session_id, ids.
- **get_wfm_bu_activityplan_occurrence_session_user_deletion_job** — Gets a session users deletion job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}/sessions/{sessionId}/users/deletions/jobs/{jobId}) Requires permission wfm:activityPlanOccurrenceSessionUserDeletionJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id, occurrence_id, session_id.
- **wfm_bu_adherence_adjustment_reasoncode_bulk_bulk_delete** — Delete adherence adjustment reason codes in bulk for a business unit. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/bulk) Requires permission wfm:adherenceAdjustmentsReasonCodes:delete. Required: business_unit_id, ids.
- **wfm_bu_adherence_adjustment_reasoncode_bulk_bulk_partial_update** — Update adherence adjustment reason codes in bulk for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/bulk) Requires permission wfm:adherenceAdjustmentsReasonCodes:edit. Required: business_unit_id, reasonCodes.
- **create_wfm_bu_adherence_adjustment_reasoncode_bulk** — Create adherence adjustment reason codes in bulk for a business unit. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/bulk) Requires permission wfm:adherenceAdjustmentsReasonCodes:add. Required: business_unit_id, reasonCodes.
- **list_all_wfm_bu_adherence_adjustment_reasoncode_bulk** — Get adherence adjustment reason codes in bulk by ID for a business unit. This API can return deleted reason codes. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/bulk) Requires permission wfm:adherenceAdjustmentsReasonCodes:view. Required: business_unit_id, ids.
- **wfm_bu_adherence_adjustment_settings_bulk_partial_update** — Update adherence adjustments settings for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/settings) Requires permission wfm:adherenceAdjustmentsSettings:edit. Required: business_unit_id, metadata.
- **genesys_cloud_wfm_bu_adherence_adjustment_settings_lookup** — Get adherence adjustments settings for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/settings) Requires permission wfm:adherenceAdjustmentsSettings:view. Required: business_unit_id.
- **create_wfm_bu_capplanning_autobest_week_forecast_forceregenerate** — Force regenerate the latest long term staffing requirements for a business unit. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate) Requires permission wfm:longTermStaffing:edit. Required: business_unit_id, week_date_id, forecast_id.
- **get_wfm_bu_capplanning_autobest_week_forecast_by_id** — Get the latest long term staffing requirements for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}) Requires permission wfm:longTermStaffing:view. The id is the forecastId. Required: id, business_unit_id, week_date_id.
- **create_wfm_bu_opportunity_enrollment_bulk_statuse_update** — Bulk update enrollment status. Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update) Requires permission wfm:opportunitiesEnrollmentsStatuses:edit. Required: business_unit_id, enrollmentIds, status.
- **wfm_bu_schedulebid_group_preferences_bulk_partial_update** — Overrides the assigned schedule bid for the specified agents. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences) Requires permission wfm:scheduleBidGroup:edit. Required: business_unit_id, bid_id, bid_group_id, agentScheduleSetOverrides.
- **genesys_cloud_wfm_bu_schedulebid_group_preferences_lookup** — Get agents schedule bid preferences for a bid group. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences) Requires permission wfm:scheduleBidGroup:view. Required: business_unit_id, bid_id, bid_group_id.
- **create_wfm_bu_week_schedule_perfprediction_recalc_uploadurl** — Upload daily activity changes to be able to request a performance prediction recalculation. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl) Requires permission wfm:schedule:edit. Required: business_unit_id, week_id, schedule_id, contentLengthBytes.
- **create_wfm_bu_week_schedule_perfprediction_recalculation** — Request a daily recalculation of the performance prediction for the associated schedule. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations) Requires permission wfm:schedule:edit. Required: business_unit_id, week_id, schedule_id, uploadKey.
- **get_wfm_bu_week_schedule_perfprediction_recalculation_by_id** — Get recalculated performance prediction result. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. The id is the recalculationId. Required: id, business_unit_id, week_id, schedule_id.
- **wfm_bu_week_shorttermforecast_longtermforecastdata_lookup** — Get the result of a long term forecast calculation. Includes modifications unless you pass the doNotApplyModifications query parameter. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata) Requires permission wfm:shortTermForecast:view. Required: business_unit_id, week_date_id, forecast_id.
- **wfm_bu_week_shorttermforecast_staffingrequirement_lookup** — Get the staffing requirement by planning group for a forecast. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement) Requires permission wfm:staffingRequirement:view. Required: business_unit_id, week_date_id, forecast_id.
- **wfm_bu_workplanbid_group_preferences_bulk_partial_update** — Overrides the assigned work plan for the specified agents. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences) Requires permission wfm:workPlanBidGroup:edit. Required: business_unit_id, bid_id, bid_group_id, agentWorkPlanOverrides.
- **genesys_cloud_wfm_bu_workplanbid_group_preferences_lookup** — Gets the work plan preferences of all the agents in the work plan bid group. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences) Requires permission wfm:workPlanBidGroup:view. Required: business_unit_id, bid_id, bid_group_id.
- **wfm_businessunit_activitycode_bulk_bulk_partial_update** — Update multiple activity codes. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/bulk) Requires permission wfm:activityCodes:edit. Required: business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_activitycode** — Create a new activity code. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes) Requires permission wfm:activityCode:add. Required: business_unit_id, name, category.
- **delete_a_genesys_cloud_wfm_businessunit_activitycode_by_id** — Deletes an activity code. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}) Requires permission wfm:activityCode:delete. The id is the activityCodeId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_activitycode_by_id** — Get an activity code. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}) Requires permission wfm:activityCode:view. The id is the activityCodeId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_activitycodes_lookup** — Get activity codes. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes) Requires any of permissions wfm:agentSchedule:view, wfm:agentTimeOffRequest:submit, wfm:activityCode:add, wfm:activityCode:delete …. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_activitycode_by_id** — Update an activity code. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}) Requires permission wfm:activityCode:edit. The id is the activityCodeId. Required: id, business_unit_id, metadata.
- **create_wfm_businessunit_activityplan_deletion_job** — Delete an activity plan. Triggers a job to delete the activity plan. No further changes to the activity plan can be made. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/deletions/jobs) Requires permission wfm:activityPlanDeletionJob:add. Required: business_unit_id, activity_plan_id.
- **get_wfm_businessunit_activityplan_deletion_job_by_id** — Gets an activity plan deletion job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/deletions/jobs/{jobId}) Requires permission wfm:activityPlanDeletionJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id.
- **list_all_genesys_cloud_wfm_businessunit_activityplan_jobs** — Gets the latest job for all activity plans in the business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs) Requires permission wfm:activityPlan:view. Required: business_unit_id.
- **genesys_cloud_wfm_businessunit_activityplan_jobs_lookup** — Gets the latest job for an activity plan in the business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/jobs) Requires permission wfm:activityPlan:view. Required: business_unit_id, activity_plan_id.
- **create_wfm_businessunit_activityplan_occurrence_deletion_job** — Delete occurrences for the activity plan. Triggers a job to delete occurrences of the activity plan. The activity plan cannot be updated until the job completes. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/deletions/jobs) Requires permission wfm:activityPlanOccurrenceDeletionJob:add. Required: business_unit_id, activity_plan_id, ids.
- **get_wfm_businessunit_activityplan_occurrence_deletion_job_by_id** — Gets an occurrences deletion job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/deletions/jobs/{jobId}) Requires permission wfm:activityPlanOccurrenceDeletionJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id.
- **get_wfm_businessunit_activityplan_occurrence_by_id** — Get a specific occurrence for the activity plan. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences/{occurrenceId}) Requires permission wfm:activityPlan:view. The id is the occurrenceId. Required: id, business_unit_id, activity_plan_id.
- **genesys_cloud_wfm_businessunit_activityplan_occurrences_lookup** — Get all occurrences for an activity plan. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/occurrences) Requires permission wfm:activityPlan:view. Required: business_unit_id, activity_plan_id.
- **create_a_genesys_cloud_wfm_businessunit_activityplan_run_job** — Run an activity plan manually. Triggers a job running the activity plan. The activity plan cannot be updated until the job completes. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs) Requires permission wfm:activityPlanRunJob:add. Required: business_unit_id, activity_plan_id.
- **get_wfm_businessunit_activityplan_run_job_by_id** — Gets an activity plan run job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}) Requires permission wfm:activityPlanRunJob:view. The id is the jobId. Required: id, business_unit_id, activity_plan_id.
- **create_a_genesys_cloud_wfm_businessunit_activityplan** — Create an activity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans) Requires permission wfm:activityPlan:add. Required: business_unit_id, name, activityCodeId, type, lengthMinutes, initialSchedulePeriod, transitionTimeMinutes, optimizationObjective, state, countsAsPaidTime.
- **get_single_genesys_cloud_wfm_businessunit_activityplan_by_id** — Get an activity plan. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}) Requires permission wfm:activityPlan:view. The id is the activityPlanId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_activityplans** — Get activity plans. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans) Requires permission wfm:activityPlan:view. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_activityplan_by_id** — Update an activity plan. If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}) Requires permission wfm:activityPlan:edit. The id is the activityPlanId. Required: id, business_unit_id.
- **wfm_businessunit_adherence_adjustment_bulk_bulk_partial_update** — Update adherence adjustments in bulk for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/bulk) Requires permission wfm:adherenceAdjustments:edit. Required: business_unit_id, adjustments.
- **list_all_wfm_businessunit_adherence_adjustment_bulk** — Get adherence adjustments in bulk by ID for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/bulk) Requires permission wfm:adherenceAdjustments:view. Required: business_unit_id, adjustmentIds.
- **create_wfm_businessunit_adherence_adjustment_query_job** — Creates an async query job for adherence adjustments in a business unit. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/query/jobs) Requires permission wfm:adherenceAdjustments:view. Required: business_unit_id, startDate, endDate.
- **get_wfm_businessunit_adherence_adjustment_query_job_by_id** — Query the status of an async adherence adjustments query job. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/query/jobs/{jobId}) Requires permission wfm:adherenceAdjustments:view. The id is the jobId. Required: id, business_unit_id.
- **list_all_wfm_businessunit_adherence_adjustment_query_jobs** — Get query job history for the logged in user. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/query/jobs) Requires permission wfm:adherenceAdjustments:view. Required: business_unit_id.
- **create_wfm_businessunit_adherence_adjustment_reasoncode** — Create an adherence adjustment reason code for a business unit. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes) Requires permission wfm:adherenceAdjustmentsReasonCodes:add. Required: business_unit_id, name, state.
- **delete_wfm_businessunit_adherence_adjustment_reasoncode_by_id** — Delete an adherence adjustment reason code for a business unit. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/{reasonCodeId}) Requires permission wfm:adherenceAdjustmentsReasonCodes:delete. The id is the reasonCodeId. Required: id, business_unit_id.
- **get_wfm_businessunit_adherence_adjustment_reasoncode_by_id** — Get an adherence adjustment reason code for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/{reasonCodeId}) Requires permission wfm:adherenceAdjustmentsReasonCodes:view. The id is the reasonCodeId. Required: id, business_unit_id.
- **list_all_wfm_businessunit_adherence_adjustment_reasoncodes** — Get adherence adjustment reason codes for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes) Requires permission wfm:adherenceAdjustmentsReasonCodes:view. Required: business_unit_id.
- **update_wfm_businessunit_adherence_adjustment_reasoncode_by_id** — Update an adherence adjustment reason code for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/reasoncodes/{reasonCodeId}) Requires permission wfm:adherenceAdjustmentsReasonCodes:edit. The id is the reasonCodeId. Required: id, business_unit_id, metadata.
- **genesys_cloud_wfm_businessunit_adherence_adjustments_search** — Query adherence adjustments for a business unit. Results will be returned using cursor pagination. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/adjustments/query) Requires permission wfm:adherenceAdjustments:view. Required: business_unit_id, startDate, endDate.
- **genesys_cloud_wfm_businessunit_adherence_explanations_search** — Query adherence explanations across an entire business unit for the requested period. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query) Requires permission wfm:adherenceExplanation:view. Required: business_unit_id, startDate, endDate.
- **genesys_cloud_wfm_businessunit_agentschedules_search** — Search published schedules. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, startDate, endDate.
- **wfm_businessunit_alternativeshift_settings_bulk_partial_update** — Update alternative shifts settings for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings) Requires permission wfm:businessUnit:edit. Required: business_unit_id, metadata.
- **genesys_cloud_wfm_businessunit_alternativeshift_settings_lookup** — Get alternative shifts settings for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings) Requires permission wfm:businessUnit:view. Required: business_unit_id.
- **get_wfm_businessunit_alternativeshift_trade_search_job_by_id** — Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}) Requires permission wfm:alternativeShift:view. The id is the jobId. Required: id, business_unit_id.
- **get_wfm_businessunit_alternativeshift_trade_by_id** — Get an alternative shifts trade in a business unit for a given trade ID. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}) Requires permission wfm:alternativeShift:view. The id is the tradeId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_alternativeshift_trades_search** — List alternative shifts trades for a given management unit or agent. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search) Requires permission wfm:alternativeShift:view. Required: business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_capacityplan_bulk_remove** — Delete capacity plans in a business unit. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove) Requires permission wfm:capacityPlan:delete. Required: business_unit_id, capacityPlanIds.
- **create_a_genesys_cloud_wfm_businessunit_capacityplan_copy** — Copy a capacity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy) Requires permission wfm:capacityPlan:add. Required: business_unit_id, capacity_plan_id, name, startBusinessUnitDate, endBusinessUnitDate.
- **genesys_cloud_wfm_businessunit_capacityplan_forecast_lookup** — Get a capacity plan's forecast inputs. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/forecast) Requires permission wfm:capacityPlanForecastInputs:view. Required: business_unit_id, capacity_plan_id.
- **create_wfm_businessunit_capacityplan_forecast_uploadurl** — Creates signed upload URLs for importing hourly and daily forecasts for a capacity plan. Returns two upload URLs, one for the hourly forecast and one for the daily forecast. Once both uploads are complete, call POST /capacityplans (new capacity plan) or PATCH /capacityplans/{capacityPlanId} (existing capacity plan) or POST /capacityplans/{capacityPlanId}/copy (copy capacity plan) with…. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/forecast/uploadurls) Requires permission wfm:capacityPlanForecast:upload. Required: business_unit_id, hourlyForecast, dailyForecast.
- **create_wfm_businessunit_capacityplan_requirement_generate** — Regenerate requirements for capacity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate) Requires permission wfm:capacityPlan:edit. Required: business_unit_id, capacity_plan_id.
- **wfm_businessunit_capacityplan_sgallocationshistory_bulk_delete** — Delete staffing group allocations history created for a capacity plan before the given date. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory) Requires permission wfm:capacityPlan:edit. Required: business_unit_id, capacity_plan_id.
- **wfm_businessunit_capacityplan_sgallocationshistory_search** — Query staffing groups allocations history for a capacity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query) Requires permission wfm:capacityPlan:view. Required: business_unit_id, capacity_plan_id, staffingGroupIds.
- **create_wfm_businessunit_capacityplan_staffinggroupallocation** — Create staffing group allocations for a capacity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations) Requires permission wfm:capacityPlan:edit. Required: business_unit_id, capacity_plan_id, numberOfWeeks, weekStartNumber, value, metric, staffingGroupIds, version.
- **wfm_businessunit_capacityplan_staffinggroupallocations_lookup** — Get a capacity plan's staffing group allocations. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations) Requires permission wfm:capacityPlan:view. Required: business_unit_id, capacity_plan_id.
- **wfm_businessunit_capacityplan_staffingrequirements_lookup** — Get a capacity plan's staffing requirements. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements) Requires permission wfm:capacityPlan:view. Required: business_unit_id, capacity_plan_id.
- **create_a_genesys_cloud_wfm_businessunit_capacityplan** — Create a new capacity plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans) Requires permission wfm:capacityPlan:add. Required: business_unit_id, name, startBusinessUnitDate, endBusinessUnitDate, fullTimeEquivalentWeeklyHours, staffingGroupAllocations.
- **get_single_genesys_cloud_wfm_businessunit_capacityplan_by_id** — Get a capacity plan. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}) Requires permission wfm:capacityPlan:view. The id is the capacityPlanId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_capacityplans** — Get list of capacity plans for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans) Requires permission wfm:capacityPlan:view. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_capacityplan_by_id** — Update a capacity plan configuration. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}) Requires permission wfm:capacityPlan:edit. The id is the capacityPlanId. Required: id, business_unit_id, metadata.
- **create_wfm_businessunit_cforecast_session_export_forecast_job** — Create a session export job. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/forecast/jobs) Requires permission wfm:mainForecastExportForecast:add. Required: business_unit_id.
- **get_wfm_businessunit_cforecast_session_export_forecast_job_by_id** — Get status of the session export job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/forecast/jobs/{jobId}) Requires permission wfm:mainForecastExportForecast:view. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_cforecast_session_export_historical_job** — Create a historical export job. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/historical/jobs) Requires permission wfm:mainForecastExportHistorical:add. Required: business_unit_id.
- **get_wfm_businessunit_cforecast_session_export_historical_job** — Get status of the historical export job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/historical/jobs/{jobId}) Requires permission wfm:mainForecastExportHistorical:view. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_cforecast_session_export_snapshot_job** — Create a snapshot export job. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/snapshot/jobs) Requires permission wfm:mainForecastExportSnapshot:view. Required: business_unit_id, snapshotId.
- **get_wfm_businessunit_cforecast_session_export_snapshot_job_by_id** — Get status of the snapshot export job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/mainforecast/continuousforecast/session/export/snapshot/jobs/{jobId}) Requires permission wfm:mainForecastExportSnapshot:add. The id is the jobId. Required: id, business_unit_id.
- **get_wfm_businessunit_decisionmetrics_job_by_id** — Gets the status of the given job. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/decisionmetrics/jobs/{jobId}) Requires permission wfm:decisionMetrics:edit. The id is the jobId. Required: id, business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_decisionmetrics_update** — Initiates the decision metrics update process. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/decisionmetrics/update) Requires permission wfm:decisionMetrics:edit. Required: business_unit_id, uploadKey.
- **create_wfm_businessunit_decisionmetrics_update_uploadurl** — Creates a signed upload URL for updating decision metrics. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/decisionmetrics/update/uploadurl) Requires permission wfm:decisionMetrics:edit. Required: business_unit_id, contentLengthBytes.
- **list_all_genesys_cloud_wfm_businessunit_divisionviews** — Get business units across divisions. (GET /api/v2/workforcemanagement/businessunits/divisionviews) Requires permission wfm:businessUnit:search.
- **create_a_genesys_cloud_wfm_businessunit_intraday** — Get intraday data for the given date for the requested planningGroupIds. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday) Requires permission wfm:intraday:view. Required: business_unit_id, businessUnitDate, categories.
- **genesys_cloud_wfm_businessunit_intraday_planninggroups_lookup** — Get intraday planning groups for the given date. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups) Requires permission wfm:intraday:view. Required: business_unit_id, date.
- **list_all_genesys_cloud_wfm_businessunit_managementunits** — Get all authorized management units in the business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits) Required: business_unit_id.
- **wfm_businessunit_minimumstaffing_settings_bulk_partial_update** — Update minimum staffing settings for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings) Requires permission wfm:minimumStaffingSettings:edit. Required: business_unit_id.
- **genesys_cloud_wfm_businessunit_minimumstaffing_settings_lookup** — Get minimum staffing settings for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings) Requires permission wfm:minimumStaffingSettings:view. Required: business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_opportunity_by_id** — Get opportunity details. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}) Requires permission wfm:opportunity:view. The id is the opportunityId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_opportunities_search** — Query opportunities within the specified date range. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query) Requires permission wfm:opportunitiesQuery:view. Required: business_unit_id, range.
- **update_a_genesys_cloud_wfm_businessunit_opportunity_by_id** — Update the opportunity. Only opportunities with Draft status can be updated. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}) Requires permission wfm:opportunity:edit. The id is the opportunityId. Required: id, business_unit_id, metadata.
- **genesys_cloud_wfm_businessunit_opportunity_bulk_publish** — Bulk publish opportunities. Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish) Requires permission wfm:opportunities:publish. Required: business_unit_id, ids.
- **create_a_genesys_cloud_wfm_businessunit_opportunity_bulk_add** — Bulk add opportunities. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add) Requires permission wfm:opportunities:add. Required: business_unit_id, opportunities.
- **create_a_genesys_cloud_wfm_businessunit_opportunity_bulk_remove** — Bulk remove opportunities. This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove) Requires permission wfm:opportunities:delete. Required: business_unit_id, ids.
- **create_wfm_businessunit_opportunity_bulk_statuse_update** — Bulk update opportunities status. If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update) Requires permission wfm:opportunitiesStatuses:edit. Required: business_unit_id, opportunityIds, status.
- **genesys_cloud_wfm_businessunit_opportunity_enrollments_search** — Query enrollments. For more information about opportunities, use the expand parameter. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query) Requires permission wfm:opportunitiesEnrollmentsQuery:view. Required: business_unit_id.
- **wfm_businessunit_opportunity_externalactivities_search** — Query opportunities by external activity IDs. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query) Requires permission wfm:opportunitiesExternalActivitiesQuery:view. Required: business_unit_id, ids.
- **create_a_genesys_cloud_wfm_businessunit_planninggroup** — Adds a new planning group. If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups) Requires permissions wfm:planningGroup:add, routing:queue:view. Required: business_unit_id, name, routePaths, serviceGoalTemplateId.
- **delete_a_genesys_cloud_wfm_businessunit_planninggroup_by_id** — Deletes the planning group. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}) Requires permission wfm:planningGroup:delete. The id is the planningGroupId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_planninggroup_by_id** — Get a planning group. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}) Requires permission wfm:planningGroup:view. The id is the planningGroupId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_planninggroups_lookup** — Gets list of planning groups. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups) Requires any of permissions wfm:planningGroup:view, wfm:shortTermForecast:view, wfm:intraday:view, wfm:agent:view …. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_planninggroup_by_id** — Updates the planning group. If the request body contains queue references in route paths, routing:queue:view is required in each referenced queue's division. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}) Requires permissions wfm:planningGroup:edit, routing:queue:view. The id is the planningGroupId. Required: id, business_unit_id, metadata.
- **create_a_genesys_cloud_wfm_businessunit_schedulebid_copy** — Copy a schedule bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy) Requires permission wfm:scheduleBid:add. Required: business_unit_id, bid_id, name.
- **create_wfm_businessunit_schedulebid_effectivescheduleset** — Fetch all the agents with effective schedule set for the given BU. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets) Requires permission wfm:scheduleBid:view. Required: business_unit_id, startDate, weekCount.
- **list_all_wfm_businessunit_schedulebid_group_summary** — Get summary of bid groups that belong to a schedule bid. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary) Requires permission wfm:scheduleBidGroup:view. Required: business_unit_id, bid_id.
- **create_a_genesys_cloud_wfm_businessunit_schedulebid_group** — Add a bid group in a given schedule bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups) Requires permission wfm:scheduleBidGroup:add. Required: business_unit_id, bid_id, name, managementUnitId, agentIds, planningGroupIds.
- **delete_a_genesys_cloud_wfm_businessunit_schedulebid_group_by_id** — Delete a schedule bid group by bid group Id. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}) Requires permission wfm:scheduleBidGroup:delete. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **get_wfm_businessunit_schedulebid_group_by_id** — Get a schedule bid group. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}) Requires permission wfm:scheduleBidGroup:view. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **update_a_genesys_cloud_wfm_businessunit_schedulebid_group_by_id** — Update a schedule bid group by bid group Id. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}) Requires permission wfm:scheduleBidGroup:edit. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **create_a_genesys_cloud_wfm_businessunit_schedulebid** — Create a new schedule bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids) Requires permission wfm:scheduleBid:add. Required: business_unit_id, name, bidWindowStartDate, bidWindowEndDate, effectiveDate, weeksToSchedule, agentRankingType, rankingTiebreakerType.
- **delete_a_genesys_cloud_wfm_businessunit_schedulebid_by_id** — Delete a schedule bid. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}) Requires permission wfm:scheduleBid:delete. The id is the bidId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_schedulebid_by_id** — Get a schedule bid. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}) Requires permission wfm:scheduleBid:view. The id is the bidId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_schedulebids** — Get list of schedule bids. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids) Requires permission wfm:scheduleBid:view. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_schedulebid_by_id** — Update a schedule bid. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}) Requires permission wfm:scheduleBid:edit. The id is the bidId. Required: id, business_unit_id.
- **wfm_businessunit_scheduler_settings_bulk_partial_update** — Update scheduler settings for a business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings) Requires permission wfm:schedulerSettings:edit. Required: business_unit_id, metadata.
- **genesys_cloud_wfm_businessunit_scheduler_settings_lookup** — Get scheduler settings for a business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings) Requires permission wfm:schedulerSettings:view. Required: business_unit_id.
- **genesys_cloud_wfm_businessunit_scheduling_run_result_lookup** — Get the result of a rescheduling operation. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result) Requires any of permissions wfm:schedule:edit, wfm:schedule:generate. Required: business_unit_id, run_id, managementUnitIds, expand.
- **delete_a_genesys_cloud_wfm_businessunit_scheduling_run_by_id** — Cancel a scheduling run. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}) Requires permission wfm:schedule:generate. The id is the runId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_scheduling_run_by_id** — Get a scheduling run. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}) Requires any of permissions wfm:schedule:generate, wfm:schedule:edit. The id is the runId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_scheduling_runs** — Get the list of scheduling runs. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs) Requires any of permissions wfm:schedule:generate, wfm:schedule:edit. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_scheduling_run_by_id** — Mark a schedule run as applied. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}) Requires permission wfm:schedule:edit. The id is the runId. Required: id, business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_servicegoaltemplate** — Adds a new service goal template. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates) Requires permission wfm:serviceGoalTemplate:add. Required: business_unit_id, name.
- **delete_wfm_businessunit_servicegoaltemplate_by_id** — Delete a service goal template. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}) Requires permission wfm:serviceGoalTemplate:delete. The id is the serviceGoalTemplateId. Required: id, business_unit_id.
- **get_wfm_businessunit_servicegoaltemplate_by_id** — Get a service goal template. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}) Requires permission wfm:serviceGoalTemplate:view. The id is the serviceGoalTemplateId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_servicegoaltemplates_lookup** — Gets list of service goal templates. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates) Requires any of permissions wfm:serviceGoalTemplate:view, wfm:planningGroup:view, wfm:shortTermForecast:view. Required: business_unit_id.
- **update_wfm_businessunit_servicegoaltemplate_by_id** — Updates a service goal template. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}) Requires permission wfm:serviceGoalTemplate:edit. The id is the serviceGoalTemplateId. Required: id, business_unit_id, metadata.
- **create_wfm_businessunit_shifttrading_trade_evaluate_job** — Queries and evaluates against shift trade configuration shift trades in a management unit per week. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. Required: business_unit_id, managementUnitIds, weekDates.
- **get_wfm_businessunit_shifttrading_trade_evaluate_job_by_id** — View results of the evaluate shift trades in a management unit per week operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs/{jobId}) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_shifttrading_trade_query_job** — Queries shift trades in a management unit per user. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. Required: business_unit_id, managementUnitIds, weekDates, userIds.
- **get_wfm_businessunit_shifttrading_trade_query_job_by_id** — View results of the query shift trades in a management unit per user operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/query/jobs/{jobId}) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_shifttrading_trade_state_bulk_job** — Bulk update multiple trade states. Permits a supervisor to approve or deny multiple trades. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs) Requires permission wfm:shiftTradeRequest:edit. Required: business_unit_id, managementUnitIds, weekDates, entities.
- **get_wfm_businessunit_shifttrading_trade_state_bulk_job_by_id** — View results of bulk update trades states operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/trades/state/bulk/jobs/{jobId}) Requires permission wfm:shiftTradeRequest:edit. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_shifttrading_unmatched_search_job** — Start an async job to find potential shift trade matches for the current receiving user. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: business_unit_id, managementUnitIds, weekDates, receivingSchedule.
- **get_wfm_businessunit_shifttrading_unmatched_search_job_by_id** — View result of potential shift trade matches for the current user. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id, business_unit_id.
- **create_wfm_businessunit_shifttrading_week_summary_job** — Retrieves the summary of shift trades in a matched state per week. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. Required: business_unit_id, managementUnitIds, weekDates.
- **get_wfm_businessunit_shifttrading_week_summary_job_by_id** — View results of the retrieve the summary of shift trades in a matched state per week operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs/{jobId}) Requires any of permissions wfm:shiftTradeRequest:view, wfm:shiftTradeRequest:edit. The id is the jobId. Required: id, business_unit_id.
- **wfm_businessunit_staffinggroup_planninggroups_search** — Gets a list of planning group to staffing groups list association. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query) Requires permission wfm:staffingGroup:view. Required: business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_staffinggroup** — Creates a new staffing group. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups) Requires permission wfm:staffingGroup:add. Required: business_unit_id, name.
- **delete_a_genesys_cloud_wfm_businessunit_staffinggroup_by_id** — Deletes a staffing group. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}) Requires permission wfm:staffingGroup:delete. The id is the staffingGroupId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_staffinggroup_by_id** — Gets a staffing group. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}) Requires permission wfm:staffingGroup:view. The id is the staffingGroupId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_staffinggroups_lookup** — Gets a list of staffing groups. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups) Requires permission wfm:staffingGroup:view. Required: business_unit_id.
- **genesys_cloud_wfm_businessunit_staffinggroups_search** — Gets staffing group associations for a list of user IDs. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query) Requires permission wfm:staffingGroup:view. Required: business_unit_id, userIds.
- **update_a_genesys_cloud_wfm_businessunit_staffinggroup_by_id** — Updates a staffing group. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}) Requires permission wfm:staffingGroup:edit. The id is the staffingGroupId. Required: id, business_unit_id, metadata.
- **create_wfm_businessunit_timeofflimit_granularityconversion** — Converts existing time-off limit to another granularity. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/granularityconversion) Requires permission wfm:timeOffLimit:convertGranularity. Required: business_unit_id, time_off_limit_id, granularity.
- **get_wfm_businessunit_timeofflimit_granularityconversion_job** — Query the convert time-off limit granularity job operation. Only the user who started the operation can query the status. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/granularityconversion/jobs/{jobId}) Requires permission wfm:timeOffLimit:convertGranularity. The id is the jobId. Required: id, business_unit_id, time_off_limit_id.
- **list_wfm_businessunit_timeofflimit_granularityconversion_jobs** — Query the list of convert time-off limit granularity job operation. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/granularityconversion/jobs) Requires permission wfm:timeOffLimit:convertGranularity. Required: business_unit_id, time_off_limit_id.
- **create_wfm_businessunit_timeofflimit_value_import** — Starts importing the uploaded time-off limit values. Call after uploading the time-off limit values data to the url supplied by the /import/uploadurl route. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/import) Requires permission wfm:timeOffLimit:edit. Required: business_unit_id, time_off_limit_id, uploadKey.
- **create_wfm_businessunit_timeofflimit_value_import_uploadurl** — Creates a signed upload URL for importing values into time-off limit. Once the upload is complete, call the /import route to start the import process. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/import/uploadurl) Requires permission wfm:timeOffLimit:edit. Required: business_unit_id, time_off_limit_id, contentLengthBytes.
- **genesys_cloud_wfm_businessunit_timeofflimit_values_bulk_update** — Sets daily values for a date range of time-off limit object. Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API. (PUT /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values) Requires permission wfm:timeOffLimit:edit. Required: business_unit_id, time_off_limit_id, metadata.
- **genesys_cloud_wfm_businessunit_timeofflimit_values_search** — Retrieves time-off limit related values based on a given set of filters. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values/query) Requires permission wfm:timeOffLimit:view. Required: business_unit_id, time_off_limit_id, dateRanges.
- **create_a_genesys_cloud_wfm_businessunit_timeofflimit** — Creates a new time-off limit object. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits) Requires permission wfm:timeOffLimit:add. Required: business_unit_id.
- **delete_a_genesys_cloud_wfm_businessunit_timeofflimit_by_id** — Deletes a time-off limit object. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}) Requires permission wfm:timeOffLimit:delete. The id is the timeOffLimitId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_timeofflimit_by_id** — Gets a time-off limit object. Returns properties of time-off limit object, but not daily values. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}) Requires permission wfm:timeOffLimit:view. The id is the timeOffLimitId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_timeofflimits** — Gets a list of time-off limit objects. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits) Requires any of permissions wfm:timeOffLimit:view, wfm:timeOffPlan:view. Required: business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit_timeoffplan** — Creates a new time-off plan. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans) Requires permission wfm:timeOffPlan:add. Required: business_unit_id, name.
- **delete_a_genesys_cloud_wfm_businessunit_timeoffplan_by_id** — Deletes a time-off plan. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}) Requires permission wfm:timeOffPlan:delete. The id is the timeOffPlanId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_timeoffplan_by_id** — Gets a time-off plan. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}) Requires permission wfm:timeOffPlan:view. The id is the timeOffPlanId. Required: id, business_unit_id.
- **genesys_cloud_wfm_businessunit_timeoffplans_lookup** — Gets a list of time-off plans. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans) Requires permission wfm:timeOffPlan:view. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_timeoffplan_by_id** — Updates a time-off plan. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}) Requires permission wfm:timeOffPlan:edit. The id is the timeOffPlanId. Required: id, business_unit_id, metadata.
- **genesys_cloud_wfm_businessunit_unavailabletime_schedules_search** — Get agent schedule generation unavailable times. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/schedules/query) Requires permission wfm:unavailableTimes:view. Required: business_unit_id, agentId, schedule.
- **genesys_cloud_wfm_businessunit_unavailabletime_settings_search** — Query availability management units settings. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/unavailabletimes/settings/query) Requires permission wfm:managementUnit:view. Required: business_unit_id, managementUnitIds.
- **list_all_genesys_cloud_wfm_businessunit_users** — Get users in the business unit. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/users) Requires permission wfm:agent:view. Required: business_unit_id.
- **wfm_businessunit_week_schedule_agentschedules_search** — Loads agent schedule data from the schedule. Used in combination with the metadata route. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_id, schedule_id, managementUnitId.
- **create_a_genesys_cloud_wfm_businessunit_week_schedule_copy** — Copy a schedule. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy) Requires permission wfm:schedule:add. Required: business_unit_id, week_id, schedule_id, description, weekDate.
- **create_a_genesys_cloud_wfm_businessunit_week_schedule_generate** — Generate a schedule. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate) Requires permission wfm:schedule:generate. Required: business_unit_id, week_id, description, weekCount.
- **wfm_businessunit_week_schedule_generationresults_lookup** — Get the generation results for a generated schedule. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_id, schedule_id.
- **wfm_businessunit_week_schedule_headcountforecast_lookup** — Get the headcount forecast by planning group for the schedule. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_id, schedule_id.
- **get_wfm_businessunit_week_schedule_history_agent_by_id** — Loads agent's schedule history. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. The id is the agentId. Required: id, business_unit_id, week_id, schedule_id.
- **create_a_genesys_cloud_wfm_businessunit_week_schedule_import** — Starts processing a schedule import. Call after uploading the schedule data to the url supplied by the /import/uploadurl route. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import) Requires permission wfm:schedule:add. Required: business_unit_id, week_id, uploadKey.
- **create_wfm_businessunit_week_schedule_import_uploadurl** — Creates a signed upload URL for importing a schedule. Once the upload is complete, call the /import route to start the schedule import process. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl) Requires permission wfm:schedule:add. Required: business_unit_id, week_id, contentLengthBytes.
- **wfm_businessunit_week_schedule_performancepredictions_lookup** — Get the performance prediction for the associated schedule. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_id, schedule_id.
- **create_a_genesys_cloud_wfm_businessunit_week_schedule_update** — Starts processing a schedule update. Call after uploading the schedule data to the url supplied by the /update/uploadurl route. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update) Requires permission wfm:schedule:edit. Required: business_unit_id, week_id, schedule_id, uploadKey.
- **create_wfm_businessunit_week_schedule_update_uploadurl** — Creates a signed upload URL for updating a schedule. Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl) Requires permission wfm:schedule:edit. Required: business_unit_id, week_id, schedule_id, contentLengthBytes.
- **create_a_genesys_cloud_wfm_businessunit_week_schedule** — Create a blank schedule. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules) Requires permission wfm:schedule:add. Required: business_unit_id, week_id, description, weekCount.
- **delete_a_genesys_cloud_wfm_businessunit_week_schedule_by_id** — Delete a schedule. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}) Requires permission wfm:schedule:delete. The id is the scheduleId. Required: id, business_unit_id, week_id.
- **get_single_genesys_cloud_wfm_businessunit_week_schedule_by_id** — Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. The id is the scheduleId. Required: id, business_unit_id, week_id.
- **list_all_genesys_cloud_wfm_businessunit_week_schedules** — Get the list of week schedules for the specified week. Use "recent" (without quotes) for the weekId path parameter to fetch all schedules for up to +/- 26 weeks from the current date. Response will include any schedule which spans the specified week. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules) Requires any of permissions wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_id.
- **genesys_cloud_wfm_businessunit_week_schedules_reschedule** — Start a rescheduling run. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule) Requires permission wfm:schedule:generate. Required: business_unit_id, week_id, schedule_id, managementUnitIds, doNotChangeWeeklyPaidTime, doNotChangeDailyPaidTime, doNotChangeShiftStartTimes, doNotChangeManuallyEditedShifts.
- **create_wfm_businessunit_week_shorttermforecast_copy** — Copy a short term forecast. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy) Requires permission wfm:shortTermForecast:add. Required: business_unit_id, week_date_id, forecast_id, description, weekDate.
- **wfm_businessunit_week_shorttermforecast_data_lookup** — Get the result of a short term forecast calculation. Includes modifications unless you pass the doNotApplyModifications query parameter. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data) Requires permission wfm:shortTermForecast:view. Required: business_unit_id, week_date_id, forecast_id.
- **create_wfm_businessunit_week_shorttermforecast_generate** — Generate a short term forecast. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate) Requires permission wfm:shortTermForecast:add. Required: business_unit_id, week_date_id, description.
- **list_wfm_businessunit_week_shorttermforecast_generationresults** — Gets the forecast generation results. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults) Requires permission wfm:shortTermForecast:view. Required: business_unit_id, week_date_id, forecast_id.
- **create_wfm_businessunit_week_shorttermforecast_import** — Starts importing the uploaded short term forecast. Call after uploading the forecast data to the url supplied by the /import/uploadurl route. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import) Requires permission wfm:shortTermForecast:add. Required: business_unit_id, week_date_id, uploadKey.
- **create_wfm_businessunit_week_shorttermforecast_import_uploadurl** — Creates a signed upload URL for importing a short term forecast. Once the upload is complete, call the /import route to start the short term forecast import process. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl) Requires permission wfm:shortTermForecast:add. Required: business_unit_id, week_date_id, contentLengthBytes.
- **wfm_businessunit_week_shorttermforecast_planninggroups_lookup** — Gets the forecast planning group snapshot. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups) Requires any of permissions wfm:shortTermForecast:view, wfm:schedule:view, wfm:publishedSchedule:view. Required: business_unit_id, week_date_id, forecast_id.
- **delete_wfm_businessunit_week_shorttermforecast_by_id** — Delete a short term forecast. Must not be tied to any schedules. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}) Requires permission wfm:shortTermForecast:delete. The id is the forecastId. Required: id, business_unit_id, week_date_id.
- **get_wfm_businessunit_week_shorttermforecast_by_id** — Get a short term forecast. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}) Requires permission wfm:shortTermForecast:view. The id is the forecastId. Required: id, business_unit_id, week_date_id.
- **list_all_genesys_cloud_wfm_businessunit_week_shorttermforecasts** — Get short term forecasts. Use "recent" (without quotes) for the weekDateId path parameter to fetch all forecasts for up to +/- 26 weeks from the current date. Response will include any forecast which spans the specified week. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts) Requires any of permissions wfm:schedule:generate, wfm:shortTermForecast:view. Required: business_unit_id, week_date_id.
- **create_a_genesys_cloud_wfm_businessunit_workplanbid_copy** — Copy a work plan bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy) Requires permission wfm:workPlanBid:add. Required: business_unit_id, bid_id, name.
- **list_all_wfm_businessunit_workplanbid_group_summary** — Get summary of bid groups that belong to a work plan bid. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary) Requires permission wfm:workPlanBidGroup:view. Required: business_unit_id, bid_id.
- **create_a_genesys_cloud_wfm_businessunit_workplanbid_group** — Add a bid group in a given work plan bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups) Requires permission wfm:workPlanBidGroup:add. Required: business_unit_id, bid_id, name, managementUnitId, agentIds, workPlans, planningGroupIds.
- **delete_a_genesys_cloud_wfm_businessunit_workplanbid_group_by_id** — Delete a bid group by bid group Id. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}) Requires permission wfm:workPlanBidGroup:delete. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **get_wfm_businessunit_workplanbid_group_by_id** — Get a bid group by bid group Id. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}) Requires permission wfm:workPlanBidGroup:view. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **update_a_genesys_cloud_wfm_businessunit_workplanbid_group_by_id** — Update a bid group by bid group Id. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}) Requires permission wfm:workPlanBidGroup:edit. The id is the bidGroupId. Required: id, business_unit_id, bid_id.
- **create_a_genesys_cloud_wfm_businessunit_workplanbid** — Create a new work plan bid. (POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids) Requires permission wfm:workPlanBid:add. Required: business_unit_id, name, bidWindowStartDate, bidWindowEndDate, effectiveDate, agentRankingType, rankingTiebreakerType, workPlanFieldsVisibleToAgents.
- **delete_a_genesys_cloud_wfm_businessunit_workplanbid_by_id** — Delete a work plan bid. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}) Requires permission wfm:workPlanBid:delete. The id is the bidId. Required: id, business_unit_id.
- **get_single_genesys_cloud_wfm_businessunit_workplanbid_by_id** — Get a work plan bid. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}) Requires permission wfm:workPlanBid:view. The id is the bidId. Required: id, business_unit_id.
- **list_all_genesys_cloud_wfm_businessunit_workplanbids** — Get list of work plan bids. (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids) Requires permission wfm:workPlanBid:view. Required: business_unit_id.
- **update_a_genesys_cloud_wfm_businessunit_workplanbid_by_id** — Update work plan bid. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}) Requires permission wfm:workPlanBid:edit. The id is the bidId. Required: id, business_unit_id.
- **create_a_genesys_cloud_wfm_businessunit** — Add a new business unit. It may take a minute or two for a new business unit to be available for api operations. (POST /api/v2/workforcemanagement/businessunits) Requires permission wfm:businessUnit:add. Required: name, divisionId, settings.
- **delete_a_genesys_cloud_wfm_businessunit_by_id** — Delete business unit. A business unit cannot be deleted if it contains one or more management units. (DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}) Requires permission wfm:businessUnit:delete. The id is the businessUnitId. Required: id.
- **get_single_genesys_cloud_wfm_businessunit_by_id** — Get business unit. Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s). (GET /api/v2/workforcemanagement/businessunits/{businessUnitId}) Requires any of permissions wfm:activityCode:add, wfm:activityCode:delete, wfm:activityCode:edit, wfm:activityCode:view …. The id is the businessUnitId. Required: id.
- **list_all_genesys_cloud_wfm_businessunits** — Get business units. (GET /api/v2/workforcemanagement/businessunits)
- **update_a_genesys_cloud_wfm_businessunit_by_id** — Update business unit. (PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}) Requires permission wfm:businessUnit:edit. The id is the businessUnitId. Required: id.
- **genesys_cloud_wfm_calendar_url_ics_bulk_delete** — Disable generated calendar link for the current user. (DELETE /api/v2/workforcemanagement/calendar/url/ics) Requires permission wfm:agentSchedule:sync.
- **create_a_genesys_cloud_wfm_calendar_url_ic** — Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned. (POST /api/v2/workforcemanagement/calendar/url/ics) Requires permissions wfm:agentSchedule:sync, wfm:agentSchedule:view.
- **genesys_cloud_wfm_calendar_url_ics_lookup** — Get existing calendar link for the current user. (GET /api/v2/workforcemanagement/calendar/url/ics) Requires permissions wfm:agentSchedule:sync, wfm:agentSchedule:view.
- **create_a_genesys_cloud_wfm_historicaldata_bulk_remove_job** — Delete the list of the historical data import entries. (POST /api/v2/workforcemanagement/historicaldata/bulk/remove/jobs) Requires permission wfm:historicalData:upload. Required: requestIds.
- **get_wfm_historicaldata_bulk_remove_job_by_id** — Retrieves delete job status for historical data imports associated with the job id. (GET /api/v2/workforcemanagement/historicaldata/bulk/remove/jobs/{jobId}) Requires permission wfm:historicalData:upload. The id is the jobId. Required: id.
- **genesys_cloud_wfm_historicaldata_bulk_remove_jobs_lookup** — Retrieves all delete job status for historical data. (GET /api/v2/workforcemanagement/historicaldata/bulk/remove/jobs) Requires permission wfm:historicalData:upload.
- **get_single_genesys_cloud_wfm_historicaldata_importstatus_by_id** — Retrieves status of the historical data imports associated with job id. (GET /api/v2/workforcemanagement/historicaldata/importstatus/{jobId}) Requires permission wfm:historicalData:upload. The id is the jobId. Required: id.
- **genesys_cloud_wfm_historicaldata_importstatus_lookup** — Retrieves status of the historical data imports of the organization. (GET /api/v2/workforcemanagement/historicaldata/importstatus) Requires permission wfm:historicalData:upload.
- **create_a_genesys_cloud_wfm_historicaldata_validate** — Trigger validation process for historical import. (POST /api/v2/workforcemanagement/historicaldata/validate) Requires permission wfm:historicalData:upload. Required: dateImportEnded, uploadKey.
- **create_a_genesys_cloud_wfm_integration_hri_timeofftype_job** — Get list of time off types configured in integration. (POST /api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs) Requires permission wfm:integration:view. Required: hris_integration_id.
- **get_wfm_integration_hri_timeofftype_job_by_id** — Query the results of time off types job. (GET /api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}) The id is the jobId. Required: id.
- **list_all_genesys_cloud_wfm_integration_hris** — Get integrations. (GET /api/v2/workforcemanagement/integrations/hris) Requires permission wfm:integration:view.
- **genesys_cloud_wfm_managementunit_adherence_lookup** — Get a list of user schedule adherence records for the requested management unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence) Requires permission wfm:realtimeAdherence:view. Required: management_unit_id.
- **wfm_managementunit_agent_workplan_bulk_bulk_partial_update** — Updates agent work plan configuration. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk) Requires permission wfm:workPlan:edit. Required: management_unit_id.
- **genesys_cloud_wfm_managementunit_agent_workplans_search** — Get agents work plans configuration. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query) Requires permission wfm:workPlan:view. Required: management_unit_id, agentIds, startDate, weekCount.
- **genesys_cloud_wfm_managementunit_agents_bulk_partial_update** — Update agent configurations. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents) Requires permission wfm:agent:edit. Required: management_unit_id.
- **get_single_genesys_cloud_wfm_managementunit_agent_by_id** — Get data for agent in the management unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}) Requires permission wfm:agent:view. The id is the agentId. Required: id, management_unit_id.
- **genesys_cloud_wfm_managementunit_agentschedules_search** — Query published schedules for given given time range for set of users. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search) Requires any of permissions wfm:publishedSchedule:view, wfm:schedule:view. Required: management_unit_id, startDate, endDate.
- **list_all_genesys_cloud_wfm_managementunit_decisionmetrics** — Gets the decision metrics of all user in given management unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/decisionmetrics) Requires permission wfm:decisionMetrics:view. Required: management_unit_id.
- **list_all_genesys_cloud_wfm_managementunit_divisionviews** — Get management units across divisions. (GET /api/v2/workforcemanagement/managementunits/divisionviews) Requires permission wfm:managementUnit:search.
- **create_wfm_managementunit_historicaladherencequery** — Request a historical adherence report. The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery) Requires permission wfm:historicalAdherence:view. Required: management_unit_id, startDate.
- **create_a_genesys_cloud_wfm_managementunit_move** — Move the requested management unit to a new business unit. Returns status 200 if the management unit is already in the requested business unit. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/move) Requires permission wfm:managementUnit:edit. Required: management_unit_id, businessUnitId.
- **wfm_managementunit_selfschedule_settings_bulk_partial_update** — Update admin self-scheduling settings for a management unit. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/selfschedule/settings) Requires permission wfm:selfScheduleSettings:edit. Required: management_unit_id, metadata.
- **genesys_cloud_wfm_managementunit_selfschedule_settings_lookup** — Get admin self-scheduling settings for a management unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/selfschedule/settings) Requires permission wfm:selfScheduleSettings:view. Required: management_unit_id.
- **list_all_genesys_cloud_wfm_managementunit_shifttrade_users** — Gets list of users available for whom you can send direct shift trade requests. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users) Requires permission wfm:agentShiftTradeRequest:participate. Required: management_unit_id.
- **create_a_genesys_cloud_wfm_managementunit_shrinkage_job** — Request a historical shrinkage report. The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs) Requires permission wfm:shrinkage:view. Required: management_unit_id, startDate.
- **wfm_managementunit_timeoffrequest_integrationstatus_search** — Retrieves integration statuses for a list of time off requests. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, timeOffRequestLookups.
- **wfm_managementunit_timeoffrequest_waitlistpositions_search** — Retrieves daily waitlist position for a list of time off requests. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, timeOffRequests.
- **create_a_genesys_cloud_wfm_managementunit_timeoffrequest** — Create a new time off request. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests) Requires permission wfm:timeOffRequest:add. Required: management_unit_id, status, users, activityCodeId.
- **genesys_cloud_wfm_managementunit_timeoffrequests_search** — Fetches time off requests matching the conditions specified in the request body. Request body requires one of the following: statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query) Requires permission wfm:timeOffRequest:view. Required: management_unit_id.
- **wfm_managementunit_unavailabletime_settings_bulk_partial_update** — Update management unit availability settings. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/unavailabletimes/settings) Requires permission wfm:managementUnit:edit. Required: management_unit_id.
- **create_wfm_managementunit_user_timeoffbalance_job** — Query time off balances for a given user for specified activity code and dates. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, user_id, activityCodeIds.
- **create_wfm_managementunit_user_timeoffrequest_estimate** — Estimates available time off for an agent. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, user_id, activityCodeId, paid.
- **list_all_wfm_managementunit_user_timeoffrequest_timeofflimits** — Retrieves time off limit, allocated and waitlisted values according to specific time off request. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits) Requires permissions wfm:timeOffRequest:view, wfm:timeOffLimit:view. Required: management_unit_id, user_id, time_off_request_id.
- **get_wfm_managementunit_user_timeoffrequest_by_id** — Get a time off request. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}) Requires permission wfm:timeOffRequest:view. The id is the timeOffRequestId. Required: id, management_unit_id, user_id.
- **genesys_cloud_wfm_managementunit_user_timeoffrequests_lookup** — Get a list of time off requests for a given user. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, user_id.
- **update_wfm_managementunit_user_timeoffrequest_by_id** — Update a time off request. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}) Requires permission wfm:timeOffRequest:edit. The id is the timeOffRequestId. Required: id, management_unit_id, user_id, metadata.
- **list_all_genesys_cloud_wfm_managementunit_users** — Get users in the management unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users) Requires any of permissions wfm:agent:view, wfm:historicalAdherence:view, wfm:publishedSchedule:view, wfm:realtimeAdherence:view …. Required: management_unit_id.
- **create_a_genesys_cloud_wfm_managementunit_workplan_copy** — Create a copy of work plan. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy) Requires permission wfm:workPlan:add. Required: management_unit_id, work_plan_id, name.
- **create_a_genesys_cloud_wfm_managementunit_workplan_validate** — Validate Work Plan. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate) Requires any of permissions wfm:workPlan:add, wfm:workPlan:edit. Required: management_unit_id, work_plan_id, id.
- **create_a_genesys_cloud_wfm_managementunit_workplanrotation_copy** — Create a copy of work plan rotation. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy) Requires permission wfm:workPlanRotation:add. Required: management_unit_id, work_plan_rotation_id, name.
- **create_a_genesys_cloud_wfm_managementunit_workplanrotation** — Create a new work plan rotation. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations) Requires permission wfm:workPlanRotation:add. Required: management_unit_id, name, dateRange, pattern.
- **delete_a_genesys_cloud_wfm_managementunit_workplanrotation_by_id** — Delete a work plan rotation. (DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}) Requires permission wfm:workPlanRotation:delete. The id is the workPlanRotationId. Required: id, management_unit_id.
- **get_wfm_managementunit_workplanrotation_by_id** — Get a work plan rotation. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}) Requires permission wfm:workPlanRotation:view. The id is the workPlanRotationId. Required: id, management_unit_id.
- **list_all_genesys_cloud_wfm_managementunit_workplanrotations** — Get work plan rotations. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations) Requires any of permissions wfm:agent:view, wfm:workPlanRotation:view. Required: management_unit_id.
- **update_a_genesys_cloud_wfm_managementunit_workplanrotation_by_id** — Update a work plan rotation. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}) Requires permission wfm:workPlanRotation:edit. The id is the workPlanRotationId. Required: id, management_unit_id, metadata.
- **create_a_genesys_cloud_wfm_managementunit_workplan** — Create a new work plan. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans) Requires permission wfm:workPlan:add. Required: management_unit_id, name.
- **delete_a_genesys_cloud_wfm_managementunit_workplan_by_id** — Delete a work plan. (DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}) Requires permission wfm:workPlan:delete. The id is the workPlanId. Required: id, management_unit_id.
- **get_single_genesys_cloud_wfm_managementunit_workplan_by_id** — Get a work plan. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}) Requires any of permissions wfm:workPlanRotation:view, wfm:workPlan:view, wfm:schedule:edit. The id is the workPlanId. Required: id, management_unit_id.
- **genesys_cloud_wfm_managementunit_workplans_lookup** — Get work plans. "expand=details" is deprecated. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans) Requires any of permissions wfm:agent:view, wfm:publishedSchedule:view, wfm:schedule:view, wfm:workPlanRotation:view …. Required: management_unit_id.
- **update_a_genesys_cloud_wfm_managementunit_workplan_by_id** — Update a work plan. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}) Requires permission wfm:workPlan:edit. The id is the workPlanId. Required: id, management_unit_id, metadata.
- **create_a_genesys_cloud_wfm_managementunit** — Add a management unit. It may take a minute or two for a new management unit to be available for api operations. (POST /api/v2/workforcemanagement/managementunits) Requires permission wfm:managementUnit:add. Required: name, businessUnitId.
- **delete_a_genesys_cloud_wfm_managementunit_by_id** — Delete management unit. (DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}) Requires permission wfm:managementUnit:delete. The id is the managementUnitId. Required: id.
- **get_single_genesys_cloud_wfm_managementunit_by_id** — Get management unit. settings.shortTermForecasting is deprecated and now lives on the business unit. (GET /api/v2/workforcemanagement/managementunits/{managementUnitId}) Requires any of permissions wfm:activityCode:add, wfm:activityCode:delete, wfm:activityCode:edit, wfm:activityCode:view …. The id is the managementUnitId. Required: id.
- **list_all_genesys_cloud_wfm_managementunits** — Get management units. (GET /api/v2/workforcemanagement/managementunits) Pages automatically with pageNumber/pageSize.
- **update_a_genesys_cloud_wfm_managementunit_by_id** — Update the requested management unit. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}) Requires permission wfm:managementUnit:edit. The id is the managementUnitId. Required: id.
- **wfm_mu_timeoffrequest_user_integrationstatus_bulk_partial_update** — Set integration status for a time off request. (PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus) Requires permission wfm:timeOffRequest:edit. Required: management_unit_id, time_off_request_id, user_id, integrationStatus.
- **create_wfm_mu_user_timeoffrequest_timeoffbalance_job** — Query time off balances for dates spanned by a given time off request. (POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs) Requires permission wfm:timeOffRequest:view. Required: management_unit_id, user_id, time_off_request_id.
- **create_a_genesys_cloud_wfm_notification_update** — Mark a list of notifications as read or unread. (POST /api/v2/workforcemanagement/notifications/update) Required: entities.
- **list_all_genesys_cloud_wfm_notifications** — Get a list of notifications for the current user. Notifications are only initially sent if you have the relevant Notify and Edit permissions. (GET /api/v2/workforcemanagement/notifications)
- **genesys_cloud_wfm_schedulebid_preference_bulk_update** — Update an agent's schedule set preference. (PUT /api/v2/workforcemanagement/schedulebids/{bidId}/preference) Requires permission wfm:agentScheduleBid:submit. Required: bid_id, submitted, agentScheduleBidPreferences.
- **genesys_cloud_wfm_schedulebid_preference_lookup** — Gets an agent's schedule bidding preference. (GET /api/v2/workforcemanagement/schedulebids/{bidId}/preference) Requires permission wfm:agentScheduleBid:submit. Required: bid_id.
- **genesys_cloud_wfm_schedulebid_schedulesets_lookup** — Gets an agent's schedule sets for a bid. (GET /api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets) Requires permission wfm:agentScheduleBid:submit. Required: bid_id.
- **genesys_cloud_wfm_schedulebids_lookup** — Gets the list of schedule bids that belong to an agent. It will fetch an open bid or upcoming bid or a bid that is closed recently. (GET /api/v2/workforcemanagement/schedulebids) Requires permission wfm:agentScheduleBid:submit.
- **get_single_genesys_cloud_wfm_schedulingjob_by_id** — Get status of the scheduling job. (GET /api/v2/workforcemanagement/schedulingjobs/{jobId}) Requires permission wfm:schedulingrequest:view. The id is the jobId. Required: id.
- **get_single_genesys_cloud_wfm_selfschedule_activitymove_by_id** — Lookup a single agent activity move based on its identifier. (GET /api/v2/workforcemanagement/selfschedule/activitymoves/{activityMoveId}) Requires permission wfm:agentSelfScheduleActivityMove:view. The id is the activityMoveId. Required: id.
- **create_a_genesys_cloud_wfm_selfschedule_job** — Agent starts an async job to edit a shift request by updating the start time of one or more activities. (POST /api/v2/workforcemanagement/selfschedule/jobs) Requires permission wfm:agentSelfScheduleJob:add. Required: activityMoves.
- **get_single_genesys_cloud_wfm_selfschedule_job_by_id** — View result of create self-schedule activity move operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/selfschedule/jobs/{jobId}) Requires permission wfm:agentSelfScheduleJob:add. The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_selfschedule_offer_job** — Agent starts async job to search for best time for offers. (POST /api/v2/workforcemanagement/selfschedule/offers/jobs) Requires permission wfm:agentSelfScheduleOffers:view. Required: shiftId, schedule.
- **get_single_genesys_cloud_wfm_selfschedule_offer_job_by_id** — View result of self-schedule search for best time for offer operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/selfschedule/offers/jobs/{jobId}) Requires permission wfm:agentSelfScheduleOffers:view. The id is the jobId. Required: id.
- **list_all_genesys_cloud_wfm_selfschedule_query** — Query self-schedule activity moves for agent. (GET /api/v2/workforcemanagement/selfschedule/query) Requires permission wfm:agentSelfScheduleQuery:view.
- **genesys_cloud_wfm_selfschedule_settings_lookup** — Agent gets the self-schedule management unit settings. (GET /api/v2/workforcemanagement/selfschedule/settings) Requires permission wfm:agentSelfScheduleSettings:view.
- **create_a_genesys_cloud_wfm_shifttrading_trade_job** — Add a shift trade job. (POST /api/v2/workforcemanagement/shifttrading/trades/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: initiatingShift.
- **get_single_genesys_cloud_wfm_shifttrading_trade_job_by_id** — View result of create trade operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/shifttrading/trades/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_shifttrading_trade_jobs_by_trade** — Updates a shift trade. This route can only be called by the initiating user. (POST /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: trade_id, weekDate, metadata.
- **get_wfm_shifttrading_trade_jobs_by_trade_by_id** — View result of update trade operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id, trade_id.
- **create_a_genesys_cloud_wfm_shifttrading_trade_match_job** — Matches a shift trade. This route can only be called by the receiving user. (POST /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: trade_id, weekDate, receivingSchedule, metadata.
- **get_single_genesys_cloud_wfm_shifttrading_trade_match_job_by_id** — View result of match shift trade operation. Only the receiving user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/match/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id, trade_id.
- **create_a_genesys_cloud_wfm_shifttrading_trade_mine_query_job** — Retrieve all my shift trades where I am either the initiating or receiving user. (POST /api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: weekDates.
- **get_wfm_shifttrading_trade_mine_query_job_by_id** — View results of retrieve all my shift trade operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/shifttrading/trades/mine/query/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id.
- **create_a_genesys_cloud_wfm_shifttrading_trade_state_job** — Update trade state by a user. (POST /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs) Requires permission wfm:agentShiftTradeRequest:participate. Required: trade_id, weekDate, state, metadata.
- **get_single_genesys_cloud_wfm_shifttrading_trade_state_job_by_id** — View result of update trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response. (GET /api/v2/workforcemanagement/shifttrading/trades/{tradeId}/state/jobs/{jobId}) Requires permission wfm:agentShiftTradeRequest:participate. The id is the jobId. Required: id, trade_id.
- **get_single_genesys_cloud_wfm_shrinkage_job_by_id** — Request to fetch the status of the historical shrinkage query. (GET /api/v2/workforcemanagement/shrinkage/jobs/{jobId}) The id is the jobId. Required: id.
- **genesys_cloud_wfm_team_adherence_lookup** — Get a list of user schedule adherence records for the requested team. (GET /api/v2/workforcemanagement/teams/{teamId}/adherence) Requires permission wfm:realtimeAdherence:view. Required: team_id.
- **create_a_genesys_cloud_wfm_team_adherence_historical** — Request a teams historical adherence report. The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true. (POST /api/v2/workforcemanagement/teams/{teamId}/adherence/historical) Requires permission wfm:historicalAdherence:view. Required: team_id, startDate, timeZone.
- **create_a_genesys_cloud_wfm_team_shrinkage_job** — Request a historical shrinkage report. The maximum supported range for historical shrinkage queries is up to 32 days. (POST /api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs) Requires permission wfm:shrinkage:view. Required: team_id, startDate, timeZone.
- **create_a_genesys_cloud_wfm_timeoffbalance_job** — Query time off balances for the current user for specified activity code and dates. (POST /api/v2/workforcemanagement/timeoffbalance/jobs) Requires permission wfm:agentTimeOffRequest:submit. Required: activityCodeIds.
- **get_single_genesys_cloud_wfm_timeoffbalance_job_by_id** — Query the results of time off types job. (GET /api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}) The id is the jobId. Required: id.
- **genesys_cloud_wfm_timeofflimit_available_search** — Queries available time off for the current user. (POST /api/v2/workforcemanagement/timeofflimits/available/query) Requires permission wfm:agentTimeOffRequest:submit. Required: activityCodeId.
- **create_a_genesys_cloud_wfm_timeoffrequest_estimate** — Estimates available time off for current user. (POST /api/v2/workforcemanagement/timeoffrequests/estimate) Requires permission wfm:agentTimeOffRequest:submit. Required: activityCodeId, paid.
- **genesys_cloud_wfm_timeoffrequest_integrationstatus_search** — Retrieves integration statuses for a list of current user time off requests. (POST /api/v2/workforcemanagement/timeoffrequests/integrationstatus/query) Requires permission wfm:agentTimeOffRequest:submit. Required: timeOffRequestIds.
- **list_all_genesys_cloud_wfm_timeoffrequest_waitlistpositions** — Get the daily waitlist positions of a time off request for the current user. (GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions) Requires permission wfm:agentTimeOffRequest:submit. Required: time_off_request_id.
- **create_a_genesys_cloud_wfm_timeoffrequest** — Create a time off request for the current user. (POST /api/v2/workforcemanagement/timeoffrequests) Requires permission wfm:agentTimeOffRequest:submit. Required: activityCodeId.
- **get_single_genesys_cloud_wfm_timeoffrequest_by_id** — Get a time off request for the current user. (GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}) Requires any of permissions wfm:agentSchedule:view, wfm:agentTimeOffRequest:submit. The id is the timeOffRequestId. Required: id.
- **genesys_cloud_wfm_timeoffrequests_lookup** — Get a list of time off requests for the current user. (GET /api/v2/workforcemanagement/timeoffrequests) Requires any of permissions wfm:agentSchedule:view, wfm:agentTimeOffRequest:submit.
- **update_a_genesys_cloud_wfm_timeoffrequest_by_id** — Update a time off request for the current user. (PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}) Requires permission wfm:agentTimeOffRequest:submit. The id is the timeOffRequestId. Required: id.
- **genesys_cloud_wfm_unavailabletime_settings_lookup** — Get availability management unit's settings for agent. (GET /api/v2/workforcemanagement/unavailabletimes/settings) Requires permission wfm:agentUnavailableTimes:submit.
- **create_a_genesys_cloud_wfm_unavailabletime_validation_job** — Validates proposed changes to an agent's unavailable time spans against scheduling rules and constraints for a specific week. (POST /api/v2/workforcemanagement/unavailabletimes/validation/jobs) Requires permission wfm:agentUnavailableTimes:submit. Required: validationWeekDate, unavailableTimes.
- **get_wfm_unavailabletime_validation_job_by_id** — Query agent unavailable times validation job. (GET /api/v2/workforcemanagement/unavailabletimes/validation/jobs/{jobId}) Requires permission wfm:agentUnavailableTimes:submit. The id is the jobId. Required: id.
- **genesys_cloud_wfm_unavailabletimes_bulk_partial_update** — Update agent unavailable times. (PATCH /api/v2/workforcemanagement/unavailabletimes) Requires permission wfm:agentUnavailableTimes:submit. Required: entities.
- **genesys_cloud_wfm_unavailabletimes_search** — Get agent unavailable times. (POST /api/v2/workforcemanagement/unavailabletimes/query) Requires permission wfm:agentUnavailableTimes:submit. Required: startDate, endDate.
- **create_a_genesys_cloud_wfm_user_activity** — Get a list of UserScheduleAdherence records for the requested users. (POST /api/v2/workforcemanagement/users/activity) Requires permission analytics:userObservation:view. Required: userIds.
- **genesys_cloud_wfm_user_workplanbidrank_bulk_bulk_partial_update** — Update bulk work plan bid ranks on users. Max 50 users can be updated at a time. (PATCH /api/v2/workforcemanagement/users/workplanbidranks/bulk) Requires permission wfm:workPlanBid:edit.
- **genesys_cloud_wfm_user_workplanbidranks_bulk_partial_update** — Update work plan bid ranks for a user. (PATCH /api/v2/workforcemanagement/users/{userId}/workplanbidranks) Requires permission wfm:workPlanBid:edit. Required: user_id.
- **genesys_cloud_wfm_user_workplanbidranks_lookup** — Get work plan bid ranks for a user. (GET /api/v2/workforcemanagement/users/{userId}/workplanbidranks) Requires permission wfm:workPlanBid:view. Required: user_id.
- **genesys_cloud_wfm_workplanbid_preferences_bulk_partial_update** — Update an agent's work plan bidding preference. (PATCH /api/v2/workforcemanagement/workplanbids/{bidId}/preferences) Requires permission wfm:agentWorkPlanBid:submit. Required: bid_id, submitted, agentWorkPlanBidPreferences.
- **genesys_cloud_wfm_workplanbid_preferences_lookup** — Gets an agent's work plan bidding preference. (GET /api/v2/workforcemanagement/workplanbids/{bidId}/preferences) Requires permission wfm:agentWorkPlanBid:submit. Required: bid_id.
- **genesys_cloud_wfm_workplanbid_workplans_lookup** — Gets an agent's work plans for a bid. (GET /api/v2/workforcemanagement/workplanbids/{bidId}/workplans) Requires permission wfm:agentWorkPlanBid:submit. Required: bid_id.
- **genesys_cloud_wfm_workplanbids_lookup** — Gets the list of work plan bids that belong to an agent. (GET /api/v2/workforcemanagement/workplanbids) Requires permission wfm:agentWorkPlanBid:submit.

## How it works

1. **Link your customer's Genesys Cloud account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach Genesys Cloud.** The Proxy API is a 1-to-1 mapping of the Genesys Cloud API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Embed conversation intelligence for contact centers** — Let your customers connect their Genesys Cloud account so your platform can pull call recordings, transcripts, and conversation details to power sales coaching, sentiment analysis, and deal insights without building a direct Genesys integration.
- **Offer a native CTI and screen-pop experience** — B2B CRMs and vertical SaaS tools can initiate outbound calls, listen to conversation events, and write wrap-up codes back to Genesys Cloud so agents work inside a single interface tied to customer records.
- **Automate QA and compliance workflows** — Quality assurance SaaS products can read speech and text analytics output, auto-create evaluations against Genesys quality forms, and push coaching appointments to supervisors when calls violate compliance rules.
- **Sync outbound campaigns from marketing and sales tools** — Marketing automation and lead-gen platforms can push qualified leads into Genesys outbound contact lists, start/stop dialer campaigns, and keep DNC lists in sync when users opt out — all from inside their own product.
- **Integrate WFM, scheduling, and adherence data with HR tools** — HRIS, payroll, and workforce planning SaaS apps can pull agent schedules, time-off requests, adherence, and shrinkage from Genesys Cloud to reconcile hours, forecast staffing, and automate approvals.

## What you can build

- **Conversation and transcript ingestion pipeline** — Pull conversation details, recordings metadata, and transcript URLs from Genesys Cloud to feed your AI models, analytics dashboards, or compliance workflows.
- **Click-to-call and live call control** — Initiate outbound calls, transfer or disconnect participants, toggle recording state, and manage conference parties directly from your product's UI.
- **Automated evaluation and coaching workflows** — Programmatically create quality evaluations against published forms, score agents, and schedule coaching appointments with annotations tied to specific conversations.
- **Outbound campaign and DNC management** — Create and update contact lists, add or remove contacts in bulk, start/stop campaigns, and keep DNC lists (phone, email, WhatsApp) continuously synced from your platform.
- **Agent presence and routing sync** — Read and update user presence, routing status, queue membership, and utilization so your workforce or HR product stays aligned with live contact center state.
- **Historical analytics export jobs** — Trigger asynchronous conversation, user, flow, and survey aggregate jobs and retrieve the results to power reporting, scorecards, and executive dashboards inside your app.

## FAQs

### How do end users authenticate their Genesys Cloud account?

Genesys Cloud uses OAuth 2.0. Truto handles the OAuth flow, token storage, and refresh so your users connect their Genesys org through a standard consent screen and your product receives a ready-to-use connection.

### Which Genesys Cloud regions are supported?

Genesys Cloud is a multi-region platform (US, EU, APAC, etc.) with region-specific API hosts. Truto routes requests to the correct regional endpoint based on the connected org, so you don't need to manage per-region base URLs.

### Can we access call recordings and transcripts?

Yes. You can retrieve conversation recordings, recording metadata, and speech-and-text analytics transcript URLs for completed conversations, including support for annotations and bulk batch requests.

### How do large data exports work given Genesys's async job model?

Many analytics and extraction endpoints (conversation details, user details, aggregates, data extraction downloads) are job-based. Truto exposes the create-job, poll-status, and fetch-results operations so you can run bulk exports without reimplementing the job lifecycle.

### Can we manage outbound dialer campaigns and DNC lists?

Yes. You can create and update contact lists, bulk add/remove/update contacts, start and stop campaigns, manage campaign rules, and maintain DNC lists across phone numbers, email addresses, and WhatsApp numbers.

### Does the integration support real-time events like incoming calls?

Genesys Cloud exposes real-time notifications via its channel/topic subscription model. Truto supports creating notification channels and subscribing to topics so your product can react to conversation, presence, and routing events as they happen.

### Can we work with custom conversation attributes and schemas?

Yes. Conversation custom attributes, external contact schemas, and workitem schemas are all accessible, so you can read and write customer-defined fields that your users have configured in their Genesys org.
