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 Response Management API

Responses, library, Response Assets, query

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

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

This API exposes 20 operations across 12 paths, and defines 79 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api.mypurecloud.com.

20 operations 12 paths 79 schemas 3 DELETE6 GET8 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 Response Management 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 20

Across 12 paths, the API surfaces 20 operations — 3 DELETE, 6 GET, 8 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Response Management 20

Responses, library, Response Assets, query

POST
/api/v2/responsemanagement/libraries/bulk
Get response libraries
postResponsemanagementLibrariesBulk body → 200400401403404408409413
POST
/api/v2/responsemanagement/libraries/query
Query libraries using criteria.
postResponsemanagementLibrariesQuery 2 params body → 200400401403404408409413
GET
/api/v2/responsemanagement/libraries
Gets a list of existing response libraries
getResponsemanagementLibraries 4 params → 200400401403404408409413
POST
/api/v2/responsemanagement/libraries
Create a response library
postResponsemanagementLibraries body → 200400401403404408409413
GET
/api/v2/responsemanagement/libraries/{libraryId}
Get details about an existing response library
getResponsemanagementLibrary 1 param → 200400401403404408409413
PUT
/api/v2/responsemanagement/libraries/{libraryId}
Update an existing response library
putResponsemanagementLibrary 1 param body → 200409400401403404408413
DELETE
/api/v2/responsemanagement/libraries/{libraryId}
Delete an existing response library
deleteResponsemanagementLibrary 1 param → default400401403404408409413
POST
/api/v2/responsemanagement/responses/query
Query responses
postResponsemanagementResponsesQuery body → 200400401403404408409413
GET
/api/v2/responsemanagement/responses/{responseId}
Get details about an existing response
getResponsemanagementResponse 2 params → 200400401403404408409413
PUT
/api/v2/responsemanagement/responses/{responseId}
Update an existing response
putResponsemanagementResponse 2 params body → 200409400401403404408413
DELETE
/api/v2/responsemanagement/responses/{responseId}
Delete an existing response
deleteResponsemanagementResponse 1 param → default400401403404408409413
GET
/api/v2/responsemanagement/responses
Gets a list of existing responses
getResponsemanagementResponses 4 params → 200400401403404408409413
POST
/api/v2/responsemanagement/responses
Create a response
postResponsemanagementResponses 1 param body → 200400401403404408409413
GET
/api/v2/responsemanagement/responseassets/{responseAssetId}
Get response asset information
getResponsemanagementResponseasset 1 param → 200400401403404408409413
PUT
/api/v2/responsemanagement/responseassets/{responseAssetId}
Update response asset
putResponsemanagementResponseasset 1 param body → 200400401403404408409413
DELETE
/api/v2/responsemanagement/responseassets/{responseAssetId}
Delete response asset
deleteResponsemanagementResponseasset 1 param → 204400401403404408409413
GET
/api/v2/responsemanagement/responseassets/status/{statusId}
Get response asset upload status
getResponsemanagementResponseassetsStatusStatusId 1 param → 200400401403404408409413
POST
/api/v2/responsemanagement/responseassets/bulk
Get response assets
postResponsemanagementResponseassetsBulk body → 200400401403404408409413
POST
/api/v2/responsemanagement/responseassets/uploads
Creates pre-signed url for uploading response asset
postResponsemanagementResponseassetsUploads body → 200400401403404408409413
POST
/api/v2/responsemanagement/responseassets/search
Search response assets
postResponsemanagementResponseassetsSearch 1 param body → 200400401403404408409413

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are User (39 properties), Group (17 properties), Response (16 properties), LocationDefinition (16 properties). Each schema is shown below with its type and property counts.

ResponseAssetRequest
object
2 properties 1 required
AddressableEntityRef
object
2 properties
PresenceDefinition
object
3 properties
Carousel
object
A WhatsApp Carousel messaging template definition
1 property 1 required
DomainEntityRef
object
3 properties
OutOfOffice
object
8 properties
ResponseEntityListing
object
10 properties
CreateResponseAssetRequest
object
3 properties 1 required
QueryCriteriaQuery
object
Query object for searching libraries based on criteria
1 property 1 required
Detail
object
4 properties
EmployerInfo
object
4 properties
LocationImage
object
2 properties
UserStations
object
4 properties
User
object
39 properties 1 required
Location
object
5 properties
ResponseAssetSearchResults
object
5 properties
LibraryBatchRequest
object
1 property 1 required
RoutingStatus
object
3 properties
GroupContact
object
5 properties 3 required
LocationEmergencyNumber
object
3 properties
WhatsAppDefinition
object
A WhatsApp messaging template definition as defined in the WhatsApp Business Manager
11 properties 2 required
UserConversationSummary
object
8 properties
MessagingTemplate
object
The messaging template identifies a structured message templates supported by a messaging channel.
1 property
Biography
object
5 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
Button
object
4 properties
LocationAddressVerificationDetails
object
4 properties
WritableDivision
object
3 properties
QueryCriteriaItem
object
A singular item used to query libraries
3 properties 2 required
Education
object
5 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
RmsAssetAddressableRef
object
4 properties
Library
object
8 properties 1 required
ResponseSubstitution
object
Contains information about the substitutions associated with a response.
3 properties 1 required
ResponseQueryResults
object
Used to return response query results
1 property 1 required
MessageFooter
object
2 properties
ResponseQueryRequest
object
Used to query for responses
4 properties
ErrorBody
object
11 properties
AppleInvitation
object
Apple Messages for Business invitation template configuration
4 properties 4 required
ResponseFilter
object
Used to filter response queries
3 properties 3 required
ResponseAssetStatus
object
4 properties
ResponseAssetBulkRequest
object
3 properties 1 required
WorkPlanBidRanks
object
4 properties
CardBodyText
object
2 properties 2 required
Response
object
Contains information about a response.
16 properties 1 required
UserAuthorization
object
4 properties
FooterTemplate
object
The Footer template identifies the Footer type and its footerUsage
2 properties
LibraryEntityListing
object
10 properties
UserPresence
object
10 properties
LocationDefinition
object
16 properties
ResponseAssetSearchRequest
object
5 properties 1 required
Division
object
3 properties
LocationAddress
object
7 properties
Limit
object
3 properties
QueryCriteriaGroup
object
A group of logical items for library queries
4 properties
ResponseEntityList
object
Query result list
10 properties
Chat
object
1 property
StatusInfo
object
2 properties
MessageHeader
object
2 properties
CarouselCard
object
3 properties 2 required
MediaSummary
object
2 properties
ResponseAssetEntityListing
object
2 properties
UserStation
object
8 properties
ResponseAssetFilter
object
6 properties
CreateResponseAssetResponse
object
3 properties
JsonSchemaDocument
object
A JSON Schema document.
8 properties
Geolocation
object
11 properties
Contact
object
7 properties
Team
object
8 properties 1 required
ResponseAsset
object
12 properties
ResourcePermissionPolicy
object
11 properties
Image
object
2 properties
ResourceConditionNode
object
5 properties
ResponseText
object
Contains information about the text associated with a response.
3 properties 1 required
ResourceConditionValue
object
2 properties
OAuthLastTokenIssued
object
1 property
DomainRole
object
2 properties
MediaSummaryDetail
object
2 properties
Group
object
17 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-response-management-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 Response Management 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.