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 Chat API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 34 operations across 22 paths, and defines 27 schemas. It is described by OpenAPI 2.0, at version v2.

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

34 operations 22 paths 27 schemas 6 DELETE13 GET6 PATCH7 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 Chat 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 34

Across 22 paths, the API surfaces 34 operations — 6 DELETE, 13 GET, 6 PATCH, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Chat 34
GET
/api/v2/chats/settings
Get Chat Settings.
getChatsSettings → 200400401403404408409413
PUT
/api/v2/chats/settings
Update Chat Settings.
putChatsSettings 1 param → 200400401403404408409413
PATCH
/api/v2/chats/settings
Patch Chat Settings.
patchChatsSettings 1 param → 200400401403404408409413
GET
/api/v2/chats/rooms/{roomJid}/messages/{messageIds}
Get messages by id(s) from a room
getChatsRoomMessage 2 params → 200400401403404408409413
GET
/api/v2/chats/users/{userId}/messages/{messageIds}
Get messages by id(s) from a 1on1
getChatsUserMessage 2 params → 200400401403404408409413
GET
/api/v2/chats/messages/{messageId}
Get a message
getChatsMessage 1 param → 200400401403404408409413
PUT
/api/v2/chats/messages/{messageId}/reactions
Update reactions to a message
putChatsMessageReactions 2 params → 204400401403404408409413
GET
/api/v2/chats/rooms/{roomJid}/messages
Get a room's message history
getChatsRoomMessages 5 params → 200400401403404408409413
POST
/api/v2/chats/rooms/{roomJid}/messages
Send a message to a room
postChatsRoomMessages 2 params → 200400401403404408409413
DELETE
/api/v2/chats/rooms/{roomJid}/messages/{messageId}
Delete a message in a room
deleteChatsRoomMessage 2 params → 204400401403404408409413
PATCH
/api/v2/chats/rooms/{roomJid}/messages/{messageId}
Edit a message in a room
patchChatsRoomMessage 3 params → 200400401403404408409413
GET
/api/v2/chats/users/{userId}
Get information for a 1on1
getChatsUser 1 param → 200400401403404408409413
GET
/api/v2/chats/users/{userId}/messages
Get 1on1 History between a user
getChatsUserMessages 5 params → 200400401403404408409413
POST
/api/v2/chats/users/{userId}/messages
Send a message to a user
postChatsUserMessages 2 params → 200400401403404408409413
DELETE
/api/v2/chats/users/{userId}/messages/{messageId}
Delete a message to a user
deleteChatsUserMessage 2 params → 204400401403404408409413
PATCH
/api/v2/chats/users/{userId}/messages/{messageId}
Edit a message to a user
patchChatsUserMessage 3 params → 200400401403404408409413
POST
/api/v2/chats/users/{userId}/messages/pins
Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
postChatsUserMessagesPins 2 params → 204400401403404408409413
DELETE
/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}
Remove a pinned message from a 1on1
deleteChatsUserMessagesPin 2 params → 204400401403404408409413
GET
/api/v2/chats/rooms/{roomJid}/participants/{participantJid}
Get a room participant
getChatsRoomParticipant 2 params → 200400401403404408409413
POST
/api/v2/chats/rooms/{roomJid}/participants/{userId}
Join a room
postChatsRoomParticipant 2 params → 204400401403404408409413
DELETE
/api/v2/chats/rooms/{roomJid}/participants/{userId}
Remove a user from a room.
deleteChatsRoomParticipant 2 params → 204400401403404408409413
GET
/api/v2/chats/rooms/{roomJid}/participants
Get room participants in a room
getChatsRoomParticipants 2 params → 200400401403404408409413
GET
/api/v2/chats/rooms/{roomJid}
Get a room
getChatsRoom 1 param → 200400401403404408409413
PATCH
/api/v2/chats/rooms/{roomJid}
Set properties for a room
patchChatsRoom 2 params → 204400401403404408409413
POST
/api/v2/chats/rooms
Create an adhoc room
postChatsRooms 1 param → 200400401403404408409413
POST
/api/v2/chats/rooms/{roomJid}/messages/pins
Add pinned messages for a room, up to a maximum of 5 pinned messages
postChatsRoomMessagesPins 2 params → 204400401403404408409413
DELETE
/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}
Remove a pinned message from a room
deleteChatsRoomMessagesPin 2 params → 204400401403404408409413
GET
/api/v2/chats/threads/{threadId}/messages
Get history by thread
getChatsThreadMessages 5 params → 200400401403404408409413
GET
/api/v2/chats/users/me/settings
Get a user's chat settings
getChatsUsersMeSettings → 200400401403404408409413
POST
/api/v2/chats/users/me/settings
Create a user's chat settings
postChatsUsersMeSettings 1 param → 204400401403404408409413
DELETE
/api/v2/chats/users/me/settings
Delete a user's chat settings
deleteChatsUsersMeSettings → 204400401403404408409413
PATCH
/api/v2/chats/users/me/settings
Update a user's chat settings
patchChatsUsersMeSettings 1 param → 200400401403404408409413
GET
/api/v2/chats/users/{userId}/settings
Get a user's chat settings
getChatsUserSettings 1 param → 200400401403404408409413
PATCH
/api/v2/chats/users/{userId}/settings
Update a user's chat settings
patchChatsUserSettings 2 params → 200400401403404408409413

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ChatMessageResponse (15 properties), ErrorBody (11 properties), Room (11 properties), UserSettingsForChat (4 properties). Each schema is shown below with its type and property counts.

AddressableEntityRef
object
2 properties
RoomUpdateRequest
object
4 properties
ChatMessageEntityListing
object
1 property
OneOnOne
object
1 property
PinnedMessageRequest
object
1 property 1 required
UserReference
object
2 properties
ChatSendMessageResponse
object
1 property 1 required
Entity
object
1 property
RoomParticipantsResponse
object
1 property
ErrorBody
object
11 properties
CreateRoomResponse
object
1 property 1 required
ChatReaction
object
2 properties 2 required
SendMessageBody
object
3 properties 1 required
UserSettingsForChat
object
4 properties 1 required
ChatMessageResponse
object
15 properties 6 required
ChatSettings
object
2 properties
MobileSettings
object
Settings for mobile devices
1 property 1 required
Limit
object
3 properties
RoomParticipant
object
1 property 1 required
Room
object
11 properties
UserChatSettingsPost
object
3 properties 1 required
RoomParticipantResponse
object
2 properties
ChatReactionUpdate
object
1 property 1 required
MobileNotificationSettings
object
Settings for a user's mobile notifications
1 property 1 required
ChatUserSettings
object
Settings for a chat user
1 property 1 required
CreateRoomRequest
object
3 properties 1 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-chat-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
#Chat
← Back to G APIs
API Details
ID
genesys:genesys-chat-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-chat-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-chat-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 Chat 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.