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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys WebChat API

WebChat deployments

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys WebChat 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 Chat. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 19 operations across 12 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version v2.

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

19 operations 12 paths 26 schemas 3 DELETE9 GET1 PATCH4 POST2 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
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys WebChat 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 19

Across 12 paths, the API surfaces 19 operations — 3 DELETE, 9 GET, 1 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

WebChat 19

WebChat deployments

POST
/api/v2/webchat/guest/conversationsdeprecated
Create an ACD chat conversation from an external customer.
postWebchatGuestConversations 1 param → 200400401403404408409413
GET
/api/v2/webchat/deployments/{deploymentId}deprecated
Get a WebChat deployment
getWebchatDeployment 1 param → 200400401403404408409413
PUT
/api/v2/webchat/deployments/{deploymentId}deprecated
Update a WebChat deployment
putWebchatDeployment 2 params → 200400401403404408409413
DELETE
/api/v2/webchat/deployments/{deploymentId}deprecated
Delete a WebChat deployment
deleteWebchatDeployment 1 param → 204400401403404408409413
GET
/api/v2/webchat/deploymentsdeprecated
List WebChat deployments
getWebchatDeployments → 200400401403404408409413
POST
/api/v2/webchat/deploymentsdeprecated
Create WebChat deployment
postWebchatDeployments 1 param → 200400401403404408409413
GET
/api/v2/webchat/settingsdeprecated
Get WebChat deployment settings
getWebchatSettings → 200400401403404408409413
PUT
/api/v2/webchat/settingsdeprecated
Update WebChat deployment settings
putWebchatSettings 1 param → 200400401403404408409413
DELETE
/api/v2/webchat/settingsdeprecated
Remove WebChat deployment settings
deleteWebchatSettings → 204400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}deprecated
Get a media request in the conversation
getWebchatGuestConversationMediarequest 2 params → 200400401403404408409413
PATCH
/api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId}deprecated
Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
patchWebchatGuestConversationMediarequest 3 params → 200400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/mediarequestsdeprecated
Get all media requests to the guest in the conversation
getWebchatGuestConversationMediarequests 1 param → 200400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}deprecated
Get a web chat conversation member
getWebchatGuestConversationMember 2 params → 200400401403404408409413
DELETE
/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}deprecated
Remove a member from a chat conversation
deleteWebchatGuestConversationMember 2 params → 204400401403404408409413
POST
/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messagesdeprecated
Send a message in a chat conversation.
postWebchatGuestConversationMemberMessages 3 params → 200400401403404408409413
POST
/api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typingdeprecated
Send a typing-indicator in a chat conversation.
postWebchatGuestConversationMemberTyping 2 params → 200400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/membersdeprecated
Get the members of a chat conversation.
getWebchatGuestConversationMembers 4 params → 200400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId}deprecated
Get a web chat conversation message
getWebchatGuestConversationMessage 2 params → 200400401403404408409413
GET
/api/v2/webchat/guest/conversations/{conversationId}/messagesdeprecated
Get the messages of a chat conversation.
getWebchatGuestConversationMessages 5 params → 200400401403404408409413

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are WebChatMemberInfo (13 properties), ErrorBody (11 properties), WebChatMemberInfoEntityList (10 properties), WebChatDeployment (10 properties). Each schema is shown below with its type and property counts.

WebChatRoutingTarget
object
5 properties 2 required
WebChatMessageEntityList
object
5 properties
WebChatGuestMediaRequestEntityList
object
1 property
WebChatDeployment
object
10 properties
WebChatMemberInfoEntityList
object
10 properties
WebChatConfig
object
1 property
ErrorBody
object
11 properties
CreateWebChatConversationResponse
object
4 properties
WebChatSettings
object
1 property
CreateWebChatMessageRequest
object
2 properties 1 required
JourneyAction
object
2 properties 2 required
JourneyCustomerSession
object
2 properties 2 required
JourneyActionMap
object
2 properties 2 required
WebChatMessage
object
8 properties 5 required
DomainEntityRef
object
3 properties
WebChatDeploymentEntityListing
object
3 properties
Limit
object
3 properties
WebChatGuestMediaRequest
object
Object representing the guest model of a media request of a chat conversation.
7 properties 2 required
GuestMemberInfo
object
7 properties 1 required
WebChatTyping
object
4 properties 4 required
CreateWebChatConversationRequest
object
6 properties 4 required
JourneyCustomer
object
2 properties 2 required
WebChatMemberInfo
object
13 properties 1 required
JourneyContext
object
3 properties 1 required
WebChatConversation
object
4 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-webchat-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Web Chat
← Back to G APIs
API Details
ID
genesys:genesys-webchat-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-webchat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-webchat-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys WebChat 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.