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

Genesys Messaging API

Messaging

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

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

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

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

13 operations 5 paths 19 schemas 3 DELETE5 GET2 PATCH2 POST1 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Messaging 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 13

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

Messaging 13

Messaging

GET
/api/v2/messaging/settingsdeprecated
Get a list of messaging settings
getMessagingSettings 2 params → 200400401403404408409413
POST
/api/v2/messaging/settingsdeprecated
Create a messaging setting
postMessagingSettings 1 param → 200201400401403404408409
GET
/api/v2/messaging/settings/defaultdeprecated
Get the organization's default settings that will be used as the default when creating an integration.
getMessagingSettingsDefault → 200400401403404408409413
PUT
/api/v2/messaging/settings/defaultdeprecated
Set the organization's default settings that may be applied to an integration when it is created.
putMessagingSettingsDefault 1 param → 200400401403404408409413
DELETE
/api/v2/messaging/settings/defaultdeprecated
Delete the organization's default setting, a global default will be applied to integrations without settings
deleteMessagingSettingsDefault → 204400401403404408409413
GET
/api/v2/messaging/settings/{messageSettingId}deprecated
Get a messaging setting
getMessagingSetting 1 param → 200400401403404408409413
DELETE
/api/v2/messaging/settings/{messageSettingId}deprecated
Delete a messaging setting
deleteMessagingSetting 1 param → 204400401403404408409413
PATCH
/api/v2/messaging/settings/{messageSettingId}deprecated
Update a messaging setting
patchMessagingSetting 2 params → 200400401403404408409413
GET
/api/v2/messaging/supportedcontent/{supportedContentId}deprecated
Get a supported content profile
getMessagingSupportedcontentSupportedContentId 1 param → 200400401403404408409413
DELETE
/api/v2/messaging/supportedcontent/{supportedContentId}deprecated
Delete a supported content profile
deleteMessagingSupportedcontentSupportedContentId 1 param → 204400401403404408409413
PATCH
/api/v2/messaging/supportedcontent/{supportedContentId}deprecated
Update a supported content profile
patchMessagingSupportedcontentSupportedContentId 2 params → 200400401403404408409413
GET
/api/v2/messaging/supportedcontentdeprecated
Get a list of Supported Content profiles
getMessagingSupportedcontent 2 params → 200400401403404408409413
POST
/api/v2/messaging/supportedcontentdeprecated
Create a Supported Content profile
postMessagingSupportedcontent 1 param → 200201400401403404408409

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), SupportedContentListing (10 properties), MessagingConfigListing (10 properties), MessagingSetting (10 properties). Each schema is shown below with its type and property counts.

MessagingSettingDefaultRequest
object
1 property 1 required
InboundOnlySetting
object
1 property
TypingSetting
object
1 property
ErrorBody
object
11 properties
MessagingSettingRequest
object
Messaging setting for messaging platform integrations
5 properties 1 required
SupportedContentListing
object
10 properties
MediaTypes
object
Media types
1 property
SettingDirection
object
2 properties
SupportedContent
object
Supported content profile for inbound and outbound messages
9 properties 2 required
MessagingSetting
object
Messaging setting for messaging platform integrations
10 properties 1 required
DomainEntityRef
object
3 properties
MediaTypeAccess
object
Media type access definitions
2 properties
MediaType
object
Media type definition
1 property
Limit
object
3 properties
EventSetting
object
1 property
MessagingConfigListing
object
10 properties
StorySetting
object
2 properties
ContentSetting
object
1 property
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-messaging-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

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