Genesys Web Deployments API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Web Deployments. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes
21 operations
across 14 paths,
and defines 143 schemas.
It is described by OpenAPI 2.0, at version v2.
Requests are made against the base URL https://api.mypurecloud.com.
The identity and technical contract details declared by the specification.
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
MessengerStyles
object
1 property
SupportCenterModuleSetting
object
4 properties
2 required
BotMessengerProfile
object
2 properties
ResourcePermissionPolicy
object
11 properties
WritableDivision
object
3 properties
Knowledge
object
2 properties
WebDeployment
object
Details about a Web Deployment
15 properties
2 required
WebDeploymentConfigurationVersionResponse
object
Details about the configuration version of a Web Deployment
23 properties
1 required
UserStations
object
4 properties
AdditionalLanguagesSynonyms
object
1 property
OAuthLastTokenIssued
object
1 property
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
IdleEventTrigger
object
Details about an idle event trigger
2 properties
1 required
MediaTypes
object
Media types
1 property
Markdown
object
1 property
IpFilter
object
Configuration for filtering tracking based on IP addresses.
2 properties
NluUtterance
object
3 properties
1 required
MediaTypeAccess
object
Media type access definitions
2 properties
Geolocation
object
11 properties
VideoSettings
object
The settings to enable video chat
4 properties
WebDeploymentsJourneyContext
object
3 properties
AutoStart
object
1 property
AuthenticationSettings
object
Settings for authenticated webdeployments.
3 properties
2 required
SupportCenterSettings
object
Settings concerning knowledge portal (previously support center)
9 properties
5 required
Humanize
object
2 properties
SupportCenterFeedbackSettings
object
1 property
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
SupportCenterCompactCategoryModuleTemplate
object
1 property
1 required
WebDeploymentsOAuthRequestParameters
object
7 properties
1 required
SupportCenterCategory
object
3 properties
WebDeploymentsAuthorizationResponse
object
2 properties
SupportCenterGlobalStyle
object
6 properties
6 required
User
object
39 properties
1 required
MediaSummaryDetail
object
2 properties
NamedEntityTypeItem
object
3 properties
1 required
SupportCenterLabelFilter
object
1 property
Biography
object
5 properties
SupportedContentReference
object
4 properties
1 required
ResourceConditionNode
object
5 properties
SupportCenterDetailedCategoryModuleSidebar
object
1 property
1 required
SelectorEventTrigger
object
Details about a selector event trigger
2 properties
2 required
NamedEntityDefinition
object
2 properties
2 required
PushIntegration
object
2 properties
JourneyAction
object
2 properties
2 required
SupportCenterScreen
object
2 properties
2 required
MessengerApps
object
The apps embedded in the messenger
2 properties
SupportCenterImage
object
1 property
1 required
SupportCenterCustomMessage
object
2 properties
2 required
ConversationClearSettings
object
1 property
DomainEntityRef
object
3 properties
ExpandableWebDeployment
object
Details about a Web Deployment
15 properties
2 required
DomainRole
object
2 properties
WebDeploymentConfigurationVersionEntityRef
object
4 properties
2 required
JourneyCustomer
object
2 properties
2 required
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
WebDeploymentHeadlessMode
object
1 property
DeploymentIdentityResolutionConfig
object
5 properties
1 required
PresenceDefinition
object
3 properties
BackgroundImageSettings
object
The settings to Agent Video background image
1 property
Detail
object
4 properties
MessengerSettings
object
Settings concerning messenger
7 properties
FileUploadMode
object
2 properties
SupportCenterStyleSetting
object
2 properties
2 required
UserAuthorization
object
4 properties
CobrowseWebMessagingSession
object
7 properties
NamedEntityTypeMechanismExample
object
2 properties
2 required
OutOfOffice
object
8 properties
UserPresence
object
10 properties
LocationEmergencyNumber
object
3 properties
ConversationAppSettings
object
Conversation settings that handles chats within the messenger
10 properties
NamedEntityTypeDefinition
object
3 properties
2 required
MessengerHomeScreen
object
2 properties
EmployerInfo
object
4 properties
RoutingStatus
object
3 properties
SupportCenterDetailedCategoryModuleTemplate
object
2 properties
2 required
ResourceConditionValue
object
2 properties
NamedEntityTypeMechanism
object
8 properties
2 required
SignedData
object
1 property
LocalizedLabels
object
Contains localized labels used in messenger apps
2 properties
Limit
object
3 properties
NotificationsSettings
object
Notification settings that handles messenger notifications
2 properties
IntentReference
object
2 properties
1 required
WebDeploymentConfigurationVersion
object
Details about the configuration version of a Web Deployment
23 properties
1 required
GroupContact
object
5 properties
3 required
WebDeploymentFlowEntityRef
object
5 properties
1 required
PauseCriteria
object
2 properties
SupportCenterImageSource
object
1 property
1 required
Contact
object
7 properties
LocationDefinition
object
16 properties
ScrollPercentageEventTrigger
object
Details about a scroll percentage event trigger
2 properties
2 required
NamedEntityTypeBinding
object
2 properties
2 required
UserConversationSummary
object
8 properties
Image
object
2 properties
Education
object
5 properties
PositionSettings
object
Settings concerning position
3 properties
UserVideoSettings
object
The settings for User Video
3 properties
FormsTrackTrigger
object
Details about a forms tracking event trigger
4 properties
4 required
ExpandableWebDeploymentEntityListing
object
5 properties
FlowVersion
object
24 properties
NluUtteranceSegment
object
2 properties
1 required
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
SupportCenterHeroStyle
object
3 properties
2 required
TrackingSettings
object
Settings that control how tracking data is collected and filtered.
4 properties
IdentityResolutionAutomergeConfig
object
2 properties
Icon
object
The icon for the launcher button
1 property
CustomI18nLabels
object
The localization settings for homescreen and push notification
2 properties
WritableStarrableDivision
object
3 properties
JourneyEventsSettings
object
Settings concerning journey events
11 properties
JourneyCustomerSession
object
2 properties
2 required
JourneyActionMap
object
2 properties
2 required
AgentVideoSettings
object
The settings for Agent Video
5 properties
UserStation
object
8 properties
FileUploadSettings
object
File upload settings for messenger
2 properties
NamedEntityAnnotation
object
1 property
1 required
IdentityResolutionExternalSource
object
2 properties
Group
object
17 properties
4 required
Location
object
5 properties
WebDeploymentConfigurationVersionEntityListing
object
5 properties
MediaType
object
Media type definition
1 property
Intent
object
2 properties
CobrowseSettings
object
Settings concerning cobrowse
8 properties
ConversationDisconnectSettings
object
2 properties
SupportedLanguage
object
2 properties
WebDeploymentActiveConfigurationOnDeployment
object
Details about the active configuration on a deployment
2 properties
NluDomainVersionReference
object
4 properties
AdditionalLanguagesIntent
object
2 properties
WebDeploymentsOAuthExchangeRequest
object
3 properties
1 required
LauncherButtonSettings
object
The settings for the launcher button
3 properties
IntentDefinition
object
7 properties
2 required
WebDeploymentsRefreshJWTRequest
object
2 properties
2 required
LocationAddress
object
7 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Genesys publishes across the network.
