Genesys

Genesys Chat API

The Chat API from Genesys — 22 operation(s) for chat.

GitHub OpenAPI

Operations 34

GET /api/v2/chats/settings Get Chat Settings #
PUT /api/v2/chats/settings Update Chat Settings #
PATCH /api/v2/chats/settings Patch Chat Settings #
GET /api/v2/chats/rooms/{roomJid}/messages/{messageIds} Get messages by id(s) from a room #
GET /api/v2/chats/users/{userId}/messages/{messageIds} Get messages by id(s) from a 1on1 #
GET /api/v2/chats/messages/{messageId} Get a message #
PUT /api/v2/chats/messages/{messageId}/reactions Update reactions to a message #
GET /api/v2/chats/rooms/{roomJid}/messages Get a room's message history #
POST /api/v2/chats/rooms/{roomJid}/messages Send a message to a room #
DELETE /api/v2/chats/rooms/{roomJid}/messages/{messageId} Delete a message in a room #
PATCH /api/v2/chats/rooms/{roomJid}/messages/{messageId} Edit a message in a room #
GET /api/v2/chats/users/{userId} Get information for a 1on1 #
GET /api/v2/chats/users/{userId}/messages Get 1on1 History between a user #
POST /api/v2/chats/users/{userId}/messages Send a message to a user #
DELETE /api/v2/chats/users/{userId}/messages/{messageId} Delete a message to a user #
PATCH /api/v2/chats/users/{userId}/messages/{messageId} Edit a message to a user #
POST /api/v2/chats/users/{userId}/messages/pins Add pinned messages for a 1on1, up to a maximum of 5 pinned messages #
DELETE /api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId} Remove a pinned message from a 1on1 #
GET /api/v2/chats/rooms/{roomJid}/participants/{participantJid} Get a room participant #
POST /api/v2/chats/rooms/{roomJid}/participants/{userId} Join a room #
DELETE /api/v2/chats/rooms/{roomJid}/participants/{userId} Remove a user from a room #
GET /api/v2/chats/rooms/{roomJid}/participants Get room participants in a room #
GET /api/v2/chats/rooms/{roomJid} Get a room #
PATCH /api/v2/chats/rooms/{roomJid} Set properties for a room #
POST /api/v2/chats/rooms Create an adhoc room #
POST /api/v2/chats/rooms/{roomJid}/messages/pins Add pinned messages for a room, up to a maximum of 5 pinned messages #
DELETE /api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId} Remove a pinned message from a room #
GET /api/v2/chats/threads/{threadId}/messages Get history by thread #
GET /api/v2/chats/users/me/settings Get a user's chat settings #
POST /api/v2/chats/users/me/settings Create a user's chat settings #
DELETE /api/v2/chats/users/me/settings Delete a user's chat settings #
PATCH /api/v2/chats/users/me/settings Update a user's chat settings #
GET /api/v2/chats/users/{userId}/settings Get a user's chat settings #
PATCH /api/v2/chats/users/{userId}/settings Update a user's chat settings #

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-chat-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-chat-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-chat-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 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 (253 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-chat-api-openapi.yml