How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys Routing API

Queues, wrapup codes, skills, email & sms config, predictive routing

Genesys Routing API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Routing. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 169 operations across 92 paths, and defines 292 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

169 operations 92 paths 292 schemas 26 DELETE75 GET20 PATCH31 POST17 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Routing API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 169

Across 92 paths, the API surfaces 169 operations — 26 DELETE, 75 GET, 20 PATCH, 31 POST, 17 PUT. Each is listed below with its method, path, parameters, and response codes.

Routing 169

Queues, wrapup codes, skills, email & sms config, predictive routing

POST
/api/v2/analytics/queues/observations/query
Query for queue observations
postAnalyticsQueuesObservationsQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/routing/activity/query
Query for user activity observations
postAnalyticsRoutingActivityQuery 3 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/estimatedwaittime
Get Estimated Wait Time
getRoutingQueueEstimatedwaittime 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime
Get Estimated Wait Time
getRoutingQueueMediatypeEstimatedwaittime 3 params → 200400401403404408409413
GET
/api/v2/routing/availablemediatypes
Get available media types
getRoutingAvailablemediatypes → 200400401403404408409413
GET
/api/v2/routing/languages/{languageId}
Get a routing language
getRoutingLanguage 1 param → 200400401403404408409413
DELETE
/api/v2/routing/languages/{languageId}
Delete a routing language
deleteRoutingLanguage 1 param → default400401403404408409413
GET
/api/v2/routing/languages
Get the list of supported languages.
getRoutingLanguages 5 params → 200400401403404408409413
POST
/api/v2/routing/languages
Create Language
postRoutingLanguages 1 param → 200400401403404408409413
GET
/api/v2/routing/queues/divisionviews
Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
getRoutingQueuesDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/routing/queues/divisionviews/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.
getRoutingQueuesDivisionviewsAll 3 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/identityresolution
Get Queue IdentityResolution Settings.
getRoutingQueueIdentityresolution 1 param → 200400401403404408409413
PUT
/api/v2/routing/queues/{queueId}/identityresolution
Update Queue IdentityResolution Settings.
putRoutingQueueIdentityresolution 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}
Get details about this queue.
getRoutingQueue 2 params → 200400401403404408409413
PUT
/api/v2/routing/queues/{queueId}
Update a queue
putRoutingQueue 2 params → 200400401403404408409413
DELETE
/api/v2/routing/queues/{queueId}
Delete a queue
deleteRoutingQueue 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/wrapupcodes
Get the wrap-up codes for a queue
getRoutingQueueWrapupcodes 4 params → 200400401403404408409413
POST
/api/v2/routing/queues/{queueId}/wrapupcodes
Add up to 100 wrap-up codes to a queue
postRoutingQueueWrapupcodes 2 params → 200400401403404408409413
DELETE
/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}
Delete a wrap-up code from a queue
deleteRoutingQueueWrapupcode 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/me
Get a paged listing of queues the user is a member of.
getRoutingQueuesMe 4 params → 200400401403404408409413
GET
/api/v2/routing/queues
Get list of queues.
getRoutingQueues 10 params → 200400401403404408409413
POST
/api/v2/routing/queues
Create a queue
postRoutingQueues 1 param → 200400401403404408409413
GET
/api/v2/routing/settings/transcription
Get Transcription Settings
getRoutingSettingsTranscription → 200400401403404408409413
PUT
/api/v2/routing/settings/transcription
Update Transcription Settings
putRoutingSettingsTranscription 1 param → 200202400401403404408409
PATCH
/api/v2/routing/settings/transcription
Patch Transcription Settings
patchRoutingSettingsTranscription 1 param → 200202400401403404408409
GET
/api/v2/routing/settings/contactcenter
Get Contact Center Settings
getRoutingSettingsContactcenter → 200400401403404408409413
PATCH
/api/v2/routing/settings/contactcenter
Update Contact Center Settings
patchRoutingSettingsContactcenter 1 param → 202400401403404408409413
GET
/api/v2/routing/settings
Get an organization's routing settings
getRoutingSettings → 200400401403404408409413
PUT
/api/v2/routing/settings
Update an organization's routing settings
putRoutingSettings 1 param → 200400401403404408409413
DELETE
/api/v2/routing/settings
Delete an organization's routing settings
deleteRoutingSettings → 204400401403404408409413
GET
/api/v2/routing/skills/{skillId}
Get Routing Skill
getRoutingSkill 1 param → 200400401403404408409413
DELETE
/api/v2/routing/skills/{skillId}
Delete Routing Skill
deleteRoutingSkill 1 param → 200400401403404408409413
PATCH
/api/v2/routing/skills/{skillId}
Update Routing Skill Division
patchRoutingSkill 2 params → 200400401403404408409413
GET
/api/v2/routing/skills
Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
getRoutingSkills 4 params → 200400401403404408409413
POST
/api/v2/routing/skills
Create Skill
postRoutingSkills 1 param → 200400401403404408409413
GET
/api/v2/routing/utilization/labels/{labelId}
Get details about this utilization label
getRoutingUtilizationLabel 1 param → 200400401403404408409413
PUT
/api/v2/routing/utilization/labels/{labelId}
Update a utilization label
putRoutingUtilizationLabel 2 params → 200400401403404408409413
DELETE
/api/v2/routing/utilization/labels/{labelId}
Delete a utilization label
deleteRoutingUtilizationLabel 2 params → 204400401403404408409413
GET
/api/v2/routing/utilization/labels/{labelId}/agents
Get list of agent ids associated with a utilization label
getRoutingUtilizationLabelAgents 1 param → 200400401403404408409413
GET
/api/v2/routing/utilization/labels
Get list of utilization labels
getRoutingUtilizationLabels 4 params → 200400401403404408409413
POST
/api/v2/routing/utilization/labels
Create a utilization label
postRoutingUtilizationLabels 1 param → 200201400401403404408409
GET
/api/v2/routing/utilization
Get the organization-wide max utilization settings.
getRoutingUtilization → 200400401403404408409413
PUT
/api/v2/routing/utilization
Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the system default values.
putRoutingUtilization 1 param → 200400401403404408409413
DELETE
/api/v2/routing/utilization
Delete the organization-wide max utilization settings and revert to the system default.
deleteRoutingUtilization → 200400401403404408409413
GET
/api/v2/routing/assessments/{assessmentId}
Retrieve a single benefit assessment.
getRoutingAssessment 1 param → 200400401403404408409413
DELETE
/api/v2/routing/assessments/{assessmentId}
Delete single benefit assessment.
deleteRoutingAssessment 1 param → 204400401403404408409413
GET
/api/v2/routing/assessments
Retrieve all benefit assessments.
getRoutingAssessments 5 params → 200400401403404408409413
POST
/api/v2/routing/assessments
Create a benefit assessment.
postRoutingAssessments 1 param → 200201400401403404408409
GET
/api/v2/routing/assessments/jobs/{jobId}
Retrieve a single benefit assessments job.
getRoutingAssessmentsJob 1 param → 202200400401403404408409
GET
/api/v2/routing/assessments/jobs
Retrieve all benefit assessment jobs.
getRoutingAssessmentsJobs 1 param → 200400401403404408409413
POST
/api/v2/routing/assessments/jobs
Create a benefit assessment job.
postRoutingAssessmentsJobs 1 param → 200202400401403404408409
PATCH
/api/v2/routing/conversations/{conversationId}
Update attributes of an in-queue conversation
patchRoutingConversation 2 params → 200400401403404408409413
GET
/api/v2/routing/email/domains/{domainId}
Get domain
getRoutingEmailDomain 2 params → 200400401403404408409413
DELETE
/api/v2/routing/email/domains/{domainId}
Delete a domain
deleteRoutingEmailDomain 1 param → 200400401403404408409413
PATCH
/api/v2/routing/email/domains/{domainId}
Update domain settings
patchRoutingEmailDomain 2 params → 200400401403404408409413
PATCH
/api/v2/routing/email/domains/{domainId}/validate
Validate domain settings
patchRoutingEmailDomainValidate 2 params → 200400401403404408409413
GET
/api/v2/routing/email/domains/{domainId}/dkim
Get domain dkim settings
getRoutingEmailDomainDkim 1 param → 200400401403404408409413
POST
/api/v2/routing/email/domains/{domainId}/dkim
Restart domain dkim
postRoutingEmailDomainDkim 1 param → 200400401403404408409413
GET
/api/v2/routing/email/domains/{domainId}/verification
Get domain verification settings
getRoutingEmailDomainVerification 1 param → 200400401403404408409413
POST
/api/v2/routing/email/domains/{domainId}/verification
Restart domain verification
postRoutingEmailDomainVerification 1 param → 200400401403404408409413
GET
/api/v2/routing/email/domains/{domainId}/mailfrom
Get domain mail from settings
getRoutingEmailDomainMailfrom 1 param → 200400401403404408409413
POST
/api/v2/routing/email/domains/{domainId}/mailfrom
Set domain mail from settings
postRoutingEmailDomainMailfrom 2 params → 200400401403404408409413
POST
/api/v2/routing/email/domains/{domainId}/testconnection
Tests the custom SMTP server integration connection set on this ACD domain
postRoutingEmailDomainTestconnection 2 params → 200400401403404408409413
GET
/api/v2/routing/email/domains
Get domains
getRoutingEmailDomains 5 params → 200400401403404408409413
POST
/api/v2/routing/email/domains
Create a domain
postRoutingEmailDomains 1 param → 200400401403404408409413
GET
/api/v2/routing/email/setting/{emailSettingId}
Get email setting. Returns the specified email setting that defines settings for email
getRoutingEmailSettingEmailSettingId 1 param → 200400401403404408409413
DELETE
/api/v2/routing/email/setting/{emailSettingId}
Delete an email setting. Removes the email setting and its associated settings
deleteRoutingEmailSettingEmailSettingId 1 param → 204400401403404408409413
PATCH
/api/v2/routing/email/setting/{emailSettingId}
Update an email setting. Modifies the settings for email setting
patchRoutingEmailSettingEmailSettingId 2 params → 200400401403404408409413
GET
/api/v2/routing/email/setting
Get a paged list of email routing settings.
getRoutingEmailSetting 2 params → 200400401403404408409413
POST
/api/v2/routing/email/setting
Create a new email setting. Used to define various settings, that can then be associated with email domains
postRoutingEmailSetting 1 param → 200400401403404408409413
GET
/api/v2/routing/email/setup
Get email setup
getRoutingEmailSetup → 200400401403404408409413
GET
/api/v2/routing/email/outbound/domains/{domainId}
Get domain
getRoutingEmailOutboundDomain 2 params → 200400401403404408409413
DELETE
/api/v2/routing/email/outbound/domains/{domainId}
Delete an outbound domain
deleteRoutingEmailOutboundDomain 1 param → 204400401403404408409413
PATCH
/api/v2/routing/email/outbound/domains/{domainId}
Update configurable settings for an email domain, such as changing the sending method (e.g., to or from SMTP).
patchRoutingEmailOutboundDomain 2 params → 200400401403404408409413
GET
/api/v2/routing/email/outbound/domains/{domainId}/activation
Get activation status (cname + dkim) of an outbound domain
getRoutingEmailOutboundDomainActivation 1 param → 200400401403404408409413
PUT
/api/v2/routing/email/outbound/domains/{domainId}/activation
Request an activation status (cname + dkim) update of an outbound domain
putRoutingEmailOutboundDomainActivation 1 param → 200400401403404408409413
POST
/api/v2/routing/email/outbound/domains/{domainId}/testconnection
Tests the custom SMTP server integration connection set on this outbound domain
postRoutingEmailOutboundDomainTestconnection 2 params → 200400401403404408409413
GET
/api/v2/routing/email/outbound/domains
Get outbound domains
getRoutingEmailOutboundDomains 4 params → 200400401403404408409413
POST
/api/v2/routing/email/outbound/domains
Create a domain
postRoutingEmailOutboundDomains 1 param → 202400401403404408409413
GET
/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution
Get a route identity resolution setting.
getRoutingEmailDomainRouteIdentityresolution 2 params → 200400401403404408409413
PUT
/api/v2/routing/email/domains/{domainName}/routes/{routeId}/identityresolution
Update identity resolution settings for a route.
putRoutingEmailDomainRouteIdentityresolution 3 params → 200400401403404408409413
GET
/api/v2/routing/email/domains/{domainName}/routes/{routeId}
Get a route
getRoutingEmailDomainRoute 3 params → 200400401403404408409413
PUT
/api/v2/routing/email/domains/{domainName}/routes/{routeId}
Update a route
putRoutingEmailDomainRoute 3 params → 200202400401403404408409
DELETE
/api/v2/routing/email/domains/{domainName}/routes/{routeId}
Delete a route
deleteRoutingEmailDomainRoute 2 params → 200202400401403404408409
GET
/api/v2/routing/email/domains/{domainName}/routes
Get routes
getRoutingEmailDomainRoutes 5 params → 200400401403404408409413
POST
/api/v2/routing/email/domains/{domainName}/routes
Create a route
postRoutingEmailDomainRoutes 2 params → 200202400401403404408409
POST
/api/v2/routing/email/outbound/domains/simulated
Create a simulated domain
postRoutingEmailOutboundDomainsSimulated 1 param → 202400401403404408409413
GET
/api/v2/routing/message/recipients/{recipientId}
Get a recipient
getRoutingMessageRecipient 1 param → 200400401403404408409413
PUT
/api/v2/routing/message/recipients/{recipientId}
Update a recipient
putRoutingMessageRecipient 2 params → 200400401403404408409413
GET
/api/v2/routing/message/recipients
Get recipients
getRoutingMessageRecipients 4 params → 200400401403404408409413
GET
/api/v2/routing/sms/addresses/{addressId}
Get an Address by Id for SMS
getRoutingSmsAddress 1 param → 200400401403404408409413
DELETE
/api/v2/routing/sms/addresses/{addressId}
Delete an Address by Id for SMS
deleteRoutingSmsAddress 1 param → 204400401403404408409413
GET
/api/v2/routing/sms/addresses
Get a list of Addresses for SMS
getRoutingSmsAddresses 2 params → 200400401403404408409413
POST
/api/v2/routing/sms/addresses
Provision an Address for SMS
postRoutingSmsAddresses 1 param → 200400401403404408409413
GET
/api/v2/routing/sms/availablephonenumbers
Get a list of available phone numbers for SMS provisioning.
getRoutingSmsAvailablephonenumbers 7 params → 200400401403404408409413
GET
/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}
Get a SMS identity resolution settings.
getRoutingSmsIdentityresolutionPhonenumber 1 param → 200400401403404408409413
PUT
/api/v2/routing/sms/identityresolution/phonenumbers/{addressId}
Update an SMS identity resolution settings.
putRoutingSmsIdentityresolutionPhonenumber 2 params → 200400401403404408409413
POST
/api/v2/routing/sms/phonenumbers/import
Imports a phone number for SMS
postRoutingSmsPhonenumbersImport 1 param → 200202400401403404408409
GET
/api/v2/routing/sms/phonenumbers/{phoneNumberId}
Get a phone number provisioned for SMS.
getRoutingSmsPhonenumber 2 params → 200400401403404408409413
DELETE
/api/v2/routing/sms/phonenumbers/{phoneNumberId}
Delete a phone number provisioned for SMS.
deleteRoutingSmsPhonenumber 1 param → 202400401403404408409413
PATCH
/api/v2/routing/sms/phonenumbers/{phoneNumberId}
Update a phone number provisioned for SMS.
patchRoutingSmsPhonenumber 2 params → 200400401403404408409413
GET
/api/v2/routing/sms/phonenumbers
Get a list of provisioned phone numbers.
getRoutingSmsPhonenumbers 12 params → 200400401403404408409413
POST
/api/v2/routing/sms/phonenumbers
Provision a phone number for SMS
postRoutingSmsPhonenumbers 1 param → 200202400401403404408409
GET
/api/v2/routing/predictors/{predictorId}
Retrieve a single predictor.
getRoutingPredictor 1 param → 200400401403404408409413
DELETE
/api/v2/routing/predictors/{predictorId}
Delete single predictor.
deleteRoutingPredictor 1 param → 204400401403404408409413
PATCH
/api/v2/routing/predictors/{predictorId}
Update single predictor.
patchRoutingPredictor 2 params → 200400401403404408409413
GET
/api/v2/routing/predictors
Retrieve all predictors.
getRoutingPredictors 7 params → 200400401403404408409413
POST
/api/v2/routing/predictors
Create a predictor.
postRoutingPredictors 1 param → 200201400401403404408409
GET
/api/v2/routing/predictors/keyperformanceindicators
Get a list of Key Performance Indicators
getRoutingPredictorsKeyperformanceindicators 2 params → 200400401403404408409413
GET
/api/v2/routing/predictors/{predictorId}/models/{modelId}/features
Retrieve Predictor Model Features.
getRoutingPredictorModelFeatures 2 params → 200400401403404408409413
GET
/api/v2/routing/predictors/{predictorId}/models
Retrieve Predictor Models and Top Features.
getRoutingPredictorModels 1 param → 200400401403404408409413
DELETE
/api/v2/routing/queues/{queueId}/members/{memberId}
Delete a queue member.
deleteRoutingQueueMember 2 params → 204400401403404408409413
PATCH
/api/v2/routing/queues/{queueId}/members/{memberId}
Update the ring number OR joined status for a queue member.
patchRoutingQueueMember 3 params → 202400401403404408409413
GET
/api/v2/routing/queues/{queueId}/members
Get the members of this queue.
getRoutingQueueMembers 13 params → 200400401403404408409413
POST
/api/v2/routing/queues/{queueId}/members
Bulk add or delete up to 100 queue members
postRoutingQueueMembers 3 params → default400401403404408409413
PATCH
/api/v2/routing/queues/{queueId}/members
Join or unjoin a set of up to 100 users for a queue
patchRoutingQueueMembers 2 params → 200400401403404408409413
DELETE
/api/v2/routing/queues/{queueId}/users/{memberId}deprecated
DEPRECATED: use DELETE /routing/queues/{queueId}/members/{memberId}. Delete queue member.
deleteRoutingQueueUser 2 params → 200400401403404408409413
PATCH
/api/v2/routing/queues/{queueId}/users/{memberId}deprecated
DEPRECATED: use PATCH /routing/queues/{queueId}/members/{memberId}. Update the ring number OR joined status for a User in a Queue.
patchRoutingQueueUser 3 params → 202400401403404408409413
GET
/api/v2/routing/queues/{queueId}/usersdeprecated
DEPRECATED: use GET /routing/queues/{queueId}/members. Get the members of this queue.
getRoutingQueueUsers 12 params → 200400401403404408409413
POST
/api/v2/routing/queues/{queueId}/usersdeprecated
DEPRECATED: use POST /routing/queues/{queueId}/members. Bulk add or delete up to 100 queue members.
postRoutingQueueUsers 3 params → default400401403404408409413
PATCH
/api/v2/routing/queues/{queueId}/usersdeprecated
DEPRECATED: use PATCH /routing/queues/{queueId}/members. Join or unjoin a set of users for a queue.
patchRoutingQueueUsers 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/assistant
Get an assistant associated with a queue.
getRoutingQueueAssistant 4 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId}
Get a Comparison Period.
getRoutingQueueComparisonperiod 2 params → 200400401403404408409413
GET
/api/v2/routing/queues/{queueId}/comparisonperiods
Get list of comparison periods
getRoutingQueueComparisonperiods 1 param → 200400401403404408409413
GET
/api/v2/routing/skillexpressions/{expressionId}
Get a skill expression by ID
getRoutingSkillexpression 3 params → 200400401403404408409413
DELETE
/api/v2/routing/skillexpressions/{expressionId}
Archive a skill expression to remove it from the set of active expressions
deleteRoutingSkillexpression 1 param → 204400401403404408409413
POST
/api/v2/routing/skillexpressions/validate
Validate and normalize a skill expression
postRoutingSkillexpressionsValidate 1 param → 200400401403404408409413
GET
/api/v2/routing/skillexpressions
Get skill expressions
getRoutingSkillexpressions 3 params → 200400401403404408409413
DELETE
/api/v2/routing/skillexpressions
Archive a set of skill expressions to remove them from the set of active expressions
deleteRoutingSkillexpressions 1 param → 204400401403404408409413
GET
/api/v2/routing/skillexpressions/queue/{queueId}
Get skill expressions associated with a queue
getRoutingSkillexpressionsQueueQueueId 3 params → 200400401403404408409413
GET
/api/v2/routing/skillgroups/{skillGroupId}/members/divisions
Get list of member divisions for this skill group.
getRoutingSkillgroupMembersDivisions 2 params → 200400401403404408409413
POST
/api/v2/routing/skillgroups/{skillGroupId}/members/divisions
Add or remove member divisions for this skill group.
postRoutingSkillgroupMembersDivisions 2 params → 204400401403404408409413
GET
/api/v2/routing/skillgroups/{skillGroupId}
Get skill group
getRoutingSkillgroup 1 param → 200400401403404408409413
DELETE
/api/v2/routing/skillgroups/{skillGroupId}
Remove skill group definition
deleteRoutingSkillgroup 1 param → 204400401403404408409413
PATCH
/api/v2/routing/skillgroups/{skillGroupId}
Update skill group definition
patchRoutingSkillgroup 2 params → 200400401403404408409413
GET
/api/v2/routing/skillgroups/{skillGroupId}/members
Get skill group members
getRoutingSkillgroupMembers 5 params → 200400401403404408409413
GET
/api/v2/routing/skillgroups
Get skill group listing
getRoutingSkillgroups 4 params → 200400401403404408409413
POST
/api/v2/routing/skillgroups
Create a skill group
postRoutingSkillgroups 1 param → 200400401403404408409413
GET
/api/v2/routing/directroutingbackup/settings/me
Get the user's Direct Routing Backup settings.
getRoutingDirectroutingbackupSettingsMe → 200400401403404408409413
PUT
/api/v2/routing/directroutingbackup/settings/me
Update the user's Direct Routing Backup settings.
putRoutingDirectroutingbackupSettingsMe 1 param → 200400401403404408409413
DELETE
/api/v2/routing/directroutingbackup/settings/me
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
deleteRoutingDirectroutingbackupSettingsMe → 204400401403404408409413
GET
/api/v2/routing/users/{userId}/directroutingbackup/settings
Get the user's Direct Routing Backup settings.
getRoutingUserDirectroutingbackupSettings 1 param → 200400401403404408409413
PUT
/api/v2/routing/users/{userId}/directroutingbackup/settings
Update the user's Direct Routing Backup settings.
putRoutingUserDirectroutingbackupSettings 2 params → 200400401403404408409413
DELETE
/api/v2/routing/users/{userId}/directroutingbackup/settings
Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
deleteRoutingUserDirectroutingbackupSettings 1 param → 204400401403404408409413
GET
/api/v2/routing/users/{userId}/utilization
Get the user's max utilization settings. If not configured, the organization-wide default is returned.
getRoutingUserUtilization 1 param → 200400401403404408409413
PUT
/api/v2/routing/users/{userId}/utilization
Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values.
putRoutingUserUtilization 2 params → 200400401403404408409413
DELETE
/api/v2/routing/users/{userId}/utilization
Delete the user's max utilization settings and revert to the organization-wide default.
deleteRoutingUserUtilization 1 param → 200400401403404408409413
GET
/api/v2/routing/wrapupcodes/divisionviews/{codeId}
Get a simplified wrap-up code.
getRoutingWrapupcodesDivisionview 1 param → 200400401403404408409413
GET
/api/v2/routing/wrapupcodes/divisionviews
Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
getRoutingWrapupcodesDivisionviews 6 params → 200400401403404408409413
GET
/api/v2/routing/wrapupcodes/{codeId}
Get details about this wrap-up code.
getRoutingWrapupcode 1 param → 200400401403404408409413
PUT
/api/v2/routing/wrapupcodes/{codeId}
Update wrap-up code
putRoutingWrapupcode 2 params → 200400401403404408409413
DELETE
/api/v2/routing/wrapupcodes/{codeId}
Delete wrap-up code
deleteRoutingWrapupcode 1 param → 200400401403404408409413
GET
/api/v2/routing/wrapupcodes
Get list of wrapup codes.
getRoutingWrapupcodes 7 params → 200400401403404408409413
POST
/api/v2/routing/wrapupcodes
Create a wrap-up code
postRoutingWrapupcodes 1 param → 200400401403404408409413
PATCH
/api/v2/users/{userId}/queues/{queueId}
Join or unjoin a queue for a user
patchUserQueue 3 params → 200400401403404408409413
GET
/api/v2/users/{userId}/queues
Get queues for user
getUserQueues 5 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/queues
Join or unjoin a set of queues for a user
patchUserQueues 3 params → 200400401403404408409413
DELETE
/api/v2/users/{userId}/routinglanguages/{languageId}
Remove a routing language from a user
deleteUserRoutinglanguage 2 params → 204400401403404408409413
PATCH
/api/v2/users/{userId}/routinglanguages/{languageId}
Update an assigned routing language's proficiency
patchUserRoutinglanguage 3 params → 200409400401403404408413
GET
/api/v2/users/{userId}/routinglanguages
List routing languages assigned to a user
getUserRoutinglanguages 4 params → 200400401403404408409413
POST
/api/v2/users/{userId}/routinglanguages
Assign a routing language to a user
postUserRoutinglanguages 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/routinglanguages/bulk
Assign multiple routing languages to a user. Max 50 routing languages in request body
patchUserRoutinglanguagesBulk 2 params → 200400401403404408409413
PUT
/api/v2/users/{userId}/routingskills/{skillId}
Update an assigned routing skill's proficiency
putUserRoutingskill 3 params → 200409400401403404408413
DELETE
/api/v2/users/{userId}/routingskills/{skillId}
Remove a routing skill from a user
deleteUserRoutingskill 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/routingskills
List routing skills assigned to a user
getUserRoutingskills 4 params → 200400401403404408409413
POST
/api/v2/users/{userId}/routingskills
Assign a routing skill to a user
postUserRoutingskills 2 params → 200400401403404408409413
PUT
/api/v2/users/{userId}/routingskills/bulk
Assign multiple routing skills to a user, replacing any current assignments
putUserRoutingskillsBulk 2 params → 200400401403404408409413
PATCH
/api/v2/users/{userId}/routingskills/bulk
Assign multiple routing skills to a user
patchUserRoutingskillsBulk 2 params → 200400401403404408409413
GET
/api/v2/users/{userId}/skillgroups
Get skill groups for a user
getUserSkillgroups 4 params → 200400401403404408409413

Schemas 292

The contract defines 292 schemas that model the data the API accepts and returns. The most detailed are CreateQueueRequest (42 properties), QueueRequest (41 properties), Queue (41 properties), UserQueue (41 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
NluInfo
object
5 properties
NluDomain
object
9 properties 1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
NluDomainVersion
object
16 properties 1 required
JsonSchemaDocument
object
A JSON Schema document.
8 properties
SmsProvisioningStatus
object
4 properties
Domains
object
The domain list settings.
3 properties
Fallback
object
2 properties
ResourcePermissionPolicy
object
11 properties
QueueEntityListing
object
10 properties
WritableDivision
object
3 properties
RoutingActivityData
object
4 properties
AvailableMediaType
object
2 properties
AutoSearchConfig
object
1 property
RoutingConversationAttributesRequest
object
6 properties
KnowledgeAnswerConfig
object
1 property 1 required
EmailSetup
object
1 property
EmailSettingEntityListing
object
10 properties
UserStations
object
4 properties
AdditionalLanguagesSynonyms
object
1 property
InboundDomainPatchRequest
object
5 properties
Script
object
15 properties
RoutingActivityQueryClause
object
2 properties 2 required
OAuthLastTokenIssued
object
1 property
QueueObservationDataContainer
object
2 properties
HelpSettings
object
2 properties 2 required
ConditionalGroupActivationPilotRule
object
2 properties
Copilot
object
13 properties 2 required
MediaSummary
object
2 properties
StatisticalSummary
object
14 properties
Queue
object
41 properties
LocationAddressVerificationDetails
object
4 properties
AcwSettings
object
2 properties
MediaTypes
object
Media types
1 property
SkillGroupMemberDivisions
object
2 properties
PredictorModelRetrainingError
object
3 properties 2 required
Recipient
object
9 properties
ExpansionCriterium
object
2 properties
CreateRoutingSkill
object
1 property 1 required
DirectRoutingMediaSettings
object
1 property
CreateBenefitAssessmentRequest
object
1 property 1 required
NluUtterance
object
3 properties 1 required
MediaTypeAccess
object
Media type access definitions
2 properties
SkillGroupRoutingCondition
object
4 properties 3 required
Geolocation
object
11 properties
SummarySettingEntity
object
2 properties
StopSettings
object
2 properties 2 required
LanguageEntityListing
object
10 properties
SmsIdentityResolutionConfig
object
3 properties 1 required
TranscriptionSettings
object
6 properties 2 required
GraphApiSettings
object
3 properties
InboundRouteEntityListing
object
10 properties
EmailSettingReference
object
Email Setting reference for email routing settings
3 properties 1 required
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
QueueMemberEntityListing
object
7 properties
UserQueueEntityListing
object
10 properties
ConditionalGroupActivationCondition
object
3 properties
Page
object
8 properties
SummaryGenerationConfig
object
2 properties 1 required
CreateBenefitAssessmentJobRequest
object
1 property
SmsPhoneNumberImport
object
8 properties 4 required
WritableEntity
object
1 property
VerificationResult
object
2 properties
QueueMemberEntityListingV1
object
10 properties
PredictorModelBrief
object
4 properties
ManualSearchConfig
object
2 properties
QueueObservationQueryPredicate
object
5 properties
KnowledgeBaseWithDialectReference
object
3 properties 2 required
SkillGroupDefinition
object
8 properties 1 required
RecipientRequest
object
1 property
DnsRecordEntry
object
3 properties
SmsAvailablePhoneNumber
object
10 properties
QueueObservationQueryResponse
object
2 properties
RoutingSkill
object
6 properties 1 required
CreateQueueRequest
object
42 properties 1 required
QueueObservationQuery
object
3 properties 2 required
PredictionResults
object
4 properties 2 required
CustomSmtpServerRequest
object
1 property
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
NamedEntityTypeItem
object
3 properties 1 required
UserRoutingLanguagePost
object
Represents an organization language assigned to a user. When assigning to a user specify the organization langauge id as the id.
4 properties 2 required
PredictorModels
object
2 properties
SkillReference
object
A skill reference extracted from the expression
3 properties
Biography
object
5 properties
InboundDomain
object
11 properties
CopilotNluDomainVersion
object
2 properties 1 required
UtilizationLabel
object
3 properties
Check
object
2 properties
SkillGroupEntityListing
object
4 properties
AnalyticsScoredAgent
object
2 properties
EmailMediaSettings
object
5 properties
SmsPhoneNumber
object
28 properties 2 required
SupportedContentReference
object
4 properties 1 required
CopilotCondition
object
2 properties 2 required
LabelUtilizationResponse
object
3 properties
OutboundQueueIdentityResolutionConfig
object
3 properties 1 required
OutboundDomainCreateRequest
object
4 properties 2 required
SkillGroupLanguageCondition
object
4 properties 3 required
SMSAvailablePhoneNumberEntityListing
object
1 property
ObservationMetricData
object
5 properties
ResourceConditionNode
object
5 properties
ConditionalGroupActivation
object
2 properties
SkillGroup
object
10 properties 2 required
RequestScoredAgent
object
2 properties
Record
object
3 properties 3 required
QueueMember
object
8 properties
NumericRange
object
4 properties
NamedEntityDefinition
object
2 properties 2 required
AuthorizedDomains
object
Domains authorized for email processing.
1 property
UserLanguageEntityListing
object
10 properties
CreatePredictorRequest
object
5 properties 2 required
ObservationValue
object
19 properties 1 required
QueueRequest
object
41 properties 1 required
PredictorModelFeature
object
3 properties
CopilotAction
object
2 properties 1 required
SkillExpressionEntityListing
object
10 properties
MessageSubtypeSettings
object
2 properties
EmailAddress
object
2 properties
ImapSettings
object
3 properties
DomainEntityRef
object
3 properties
SmsPhoneNumberEntityListing
object
10 properties
SmsPhoneNumberProvision
object
8 properties 3 required
OutboundDomain
object
8 properties 1 required
SmsAddress
object
9 properties
ConversationProfile
object
2 properties 2 required
SkillExpressionData
object
Request data for skill expression validation
1 property 1 required
AnswerGenerationConfig
object
1 property 1 required
QueueMessagingAddresses
object
3 properties
ContactCenterSettings
object
1 property
WrapUpCodeReference
object
1 property
UpdateSkillDivisionRequest
object
1 property
WrapupCode
object
9 properties 1 required
InactivityTimeoutSettings
object
3 properties
DomainRole
object
2 properties
RoutingSettings
object
1 property
TestMessage
object
7 properties 3 required
RoutingActivityMetricValue
object
5 properties
AssistantQueue
object
6 properties 2 required
QueueObservationQueryFilter
object
3 properties 1 required
ServiceLevel
object
2 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
RoutingConversationAttributesResponse
object
7 properties
PredictorModel
object
7 properties
Signature
object
4 properties
PresenceDefinition
object
3 properties
AgentDirectRoutingBackupSettings
object
5 properties
SkillExpression
object
A skill expression entity with ID, expression string (raw or normalized), and queue ID
5 properties
MemberGroup
object
6 properties
Detail
object
4 properties
CopilotFallbackAction
object
2 properties 1 required
RecipientListing
object
10 properties
MediaUtilization
object
3 properties
GoogleDialogflowConfig
object
2 properties 1 required
UserAuthorization
object
4 properties
Language
object
6 properties 1 required
StarrableDivision
object
3 properties
NamedEntityTypeMechanismExample
object
2 properties 2 required
InboundDomainEntityListing
object
10 properties
OutboundDomainPatchRequest
object
3 properties
AssessmentJobListing
object
3 properties
OutOfOffice
object
8 properties
UserPresence
object
10 properties
ScoredAgent
object
2 properties
LocationEmergencyNumber
object
3 properties
Compliance
object
3 properties 3 required
QueueObservationQueryClause
object
2 properties 2 required
DirectRouting
object
6 properties
KpiResult
object
6 properties
NamedEntityTypeDefinition
object
3 properties 2 required
UpdateUtilizationLabelRequest
object
1 property 1 required
SkillsToRemove
object
3 properties
UtilizationRequest
object
3 properties
EmployerInfo
object
4 properties
CopilotNluDomain
object
4 properties 2 required
AssessmentListing
object
4 properties
UserRoutingSkillPost
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
4 properties 2 required
CreateUtilizationLabelRequest
object
2 properties 1 required
SmsAddressProvision
object
9 properties 6 required
RoutingRule
object
3 properties
MailFromResult
object
3 properties 1 required
RoutingStatus
object
3 properties
ResourceConditionValue
object
2 properties
ComparisonPeriod
object
7 properties
ComparisonPeriodListing
object
3 properties
RouteIdentityResolutionConfig
object
3 properties 1 required
NamedEntityTypeMechanism
object
8 properties 2 required
Operation
object
10 properties
InboundRoute
object
19 properties 2 required
RoutingActivityEntityData
object
10 properties 1 required
PredictorModelFeatureListing
object
1 property
SmsPhoneNumberPatchRequest
object
3 properties
SkillExpressionValidationResult
object
Result of skill expression validation
5 properties
IdentityResolutionQueueConfig
object
1 property
Limit
object
3 properties
CallbackMediaSettings
object
18 properties
RoutingActivityResponse
object
2 properties
Assistant
object
13 properties 2 required
IntentReference
object
2 properties 1 required
WrapUpCodeConfig
object
1 property 1 required
Chat
object
1 property
EmailErrorInfo
object
2 properties
GroupContact
object
5 properties 3 required
InboundDomainCreateRequest
object
7 properties 1 required
TranscriptionConfig
object
1 property 1 required
EstimatedWaitTimePredictions
object
1 property 1 required
Contact
object
7 properties
QueueEmailAddress
object
2 properties
LocationDefinition
object
16 properties
NamedEntityTypeBinding
object
2 properties 2 required
DmarcResult
object
Represents the DMARC verification result for an email domain
4 properties 3 required
AgentOwnedRouting
object
3 properties
Actions
object
1 property
Image
object
2 properties
UserConversationSummary
object
8 properties
Education
object
5 properties
RuleEngineConfig
object
2 properties 1 required
ConditionalGroupRoutingRule
object
6 properties
OutcomeConfig
object
1 property
UserReference
object
2 properties
UserReferenceWithName
object
3 properties
BenefitAssessmentJob
object
5 properties
RoutingActivityQueryMetric
object
2 properties 1 required
OutboundDomainEntityListing
object
10 properties
ComplianceResponse
object
1 property 1 required
KeyPerformanceIndicator
object
15 properties
FlowVersion
object
24 properties
KnowledgeSuggestionConfig
object
4 properties 1 required
PredictorWorkloadBalancing
object
3 properties 1 required
KnowledgeBaseReference
object
4 properties 1 required
BenefitAssessment
object
8 properties
EmailSetting
object
Email routing settings.
4 properties 2 required
Bullseye
object
1 property
UserSkillEntityListing
object
10 properties
ErrorBody
object
11 properties
SkillGroupMemberEntityListing
object
4 properties
Division
object
3 properties
UtilizationResponse
object
3 properties
LocationImage
object
2 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
NluUtteranceSegment
object
2 properties 1 required
UserSkillGroupEntityListing
object
4 properties
Predictor
object
12 properties 2 required
RoutingActivityQueryPredicate
object
4 properties
SkillGroupWithMemberDivisions
object
11 properties 2 required
NluConfig
object
2 properties 2 required
SkillExpressionValidationError
object
A validation error found in the expression
3 properties
WritableStarrableDivision
object
3 properties
ConditionalGroupRouting
object
1 property
MediaSettings
object
5 properties
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
LabelUtilizationRequest
object
2 properties
UserQueue
object
41 properties
MessageMediaSettings
object
8 properties
WrapupCodeEntityListing
object
10 properties
NamedEntityAnnotation
object
1 property 1 required
OptInSettings
object
2 properties 2 required
PredictorListing
object
4 properties
UtilizationLabelEntityListing
object
10 properties
Group
object
17 properties 4 required
RoutingActivityQuery
object
4 properties 2 required
Location
object
5 properties
MediaType
object
Media type definition
1 property
Intent
object
2 properties
QueueMediaSettings
object
5 properties
Flow
object
24 properties 1 required
SupportedLanguage
object
2 properties
SkillEntityListing
object
10 properties
NluDomainVersionReference
object
4 properties
AvailableMediaTypeEntityListing
object
1 property
AgentMaxUtilizationResponse
object
4 properties
EmailOutboundDomainResult
object
7 properties
RoutingActivityQueryFilter
object
3 properties 1 required
SkillGroupCondition
object
3 properties 3 required
AdditionalLanguagesIntent
object
2 properties
WrapupCodeRequest
object
9 properties 1 required
KeyPerformanceIndicatorAssessment
object
3 properties
CannedResponseLibraries
object
2 properties
RuleConfig
object
3 properties 2 required
PatchPredictorRequest
object
3 properties
SmsAddressEntityListing
object
10 properties
CopilotRule
object
2 properties 2 required
RecipientFlow
object
1 property
PredictorSchedule
object
2 properties 1 required
IntentDefinition
object
7 properties 2 required
WrapupCodePredictionConfig
object
1 property 1 required
LocationAddress
object
7 properties
Ring
object
3 properties
SkillGroupMemberDivisionList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-routing-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Routing API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.