Genesys

Genesys WebChat API

WebChat deployments

GitHub OpenAPI
Business capability
Customer Inquiry Management BC-430.10

Operations 19

POST /api/v2/webchat/guest/conversations Create an ACD chat conversation from an external customer #
GET /api/v2/webchat/deployments/{deploymentId} Get a WebChat deployment #
PUT /api/v2/webchat/deployments/{deploymentId} Update a WebChat deployment #
DELETE /api/v2/webchat/deployments/{deploymentId} Delete a WebChat deployment #
GET /api/v2/webchat/deployments List WebChat deployments #
POST /api/v2/webchat/deployments Create WebChat deployment #
GET /api/v2/webchat/settings Get WebChat deployment settings #
PUT /api/v2/webchat/settings Update WebChat deployment settings #
DELETE /api/v2/webchat/settings Remove WebChat deployment settings #
GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId} Get a media request in the conversation #
PATCH /api/v2/webchat/guest/conversations/{conversationId}/mediarequests/{mediaRequestId} Update a media request in the conversation, setting the state to… #
GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests Get all media requests to the guest in the conversation #
GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} Get a web chat conversation member #
DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} Remove a member from a chat conversation #
POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages Send a message in a chat conversation #
POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing Send a typing-indicator in a chat conversation #
GET /api/v2/webchat/guest/conversations/{conversationId}/members Get the members of a chat conversation #
GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId} Get a web chat conversation message #
GET /api/v2/webchat/guest/conversations/{conversationId}/messages Get the messages of a chat conversation #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-webchat-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys:genesys-webchat-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

genesys-webchat-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Web Chat API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (161 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-webchat-api-openapi.yml