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

Customer intent

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

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

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

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

16 operations 10 paths 22 schemas 2 DELETE7 GET2 PATCH5 POST

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 Intents 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 16

Across 10 paths, the API surfaces 16 operations — 2 DELETE, 7 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Intents 16

Customer intent

GET
/api/v2/intents/categories
Get categories
getIntentsCategories 3 params → 200400401403404408409413
POST
/api/v2/intents/categories
Create category
postIntentsCategories 1 param → 200400401403404408409413
GET
/api/v2/intents/categories/{categoryId}
Get category for categoryId
getIntentsCategory 1 param → 200400401403404408409413
DELETE
/api/v2/intents/categories/{categoryId}
Delete category for categoryId
deleteIntentsCategory 1 param → 204400401403404408409413
PATCH
/api/v2/intents/categories/{categoryId}
Patch category for categoryId
patchIntentsCategory 2 params → 200400401403404408409413
POST
/api/v2/intents/assignments/externalcontacts/{externalContactId}/customerintents/{customerIntentId}/assignment
Create customer intent assignment for external contact
postIntentsAssignmentsExternalcontactCustomerintentAssignment 3 params → 200400401403404408409413
GET
/api/v2/intents/assignments/externalcontacts/{externalContactId}
Get customer intent assignments for externalContactId
getIntentsAssignmentsExternalcontact 3 params → 200400401403404408409413
GET
/api/v2/intents/customerintents/{customerIntentId}
Get customer intent for customerIntentId
getIntentsCustomerintent 1 param → 200400401403404408409413
DELETE
/api/v2/intents/customerintents/{customerIntentId}
Delete customer intent for customerIntentId
deleteIntentsCustomerintent 1 param → 204400401403404408409413
PATCH
/api/v2/intents/customerintents/{customerIntentId}
Patch customer intent for customerIntentId
patchIntentsCustomerintent 2 params → 200400401403404408409413
POST
/api/v2/intents/customerintents/{customerIntentId}/sourceintents/bulk/remove
Bulk remove source intents mapped to a customer intent
postIntentsCustomerintentSourceintentsBulkRemove 2 params → 200400401403404408409413
POST
/api/v2/intents/customerintents/{customerIntentId}/sourceintents/bulk/add
Bulk add source intents to a customer intent
postIntentsCustomerintentSourceintentsBulkAdd 2 params → 200400401403404408409413
GET
/api/v2/intents/customerintents
Get customer intents
getIntentsCustomerintents 4 params → 200400401403404408409413
POST
/api/v2/intents/customerintents
Create customer intents
postIntentsCustomerintents 1 param → 200400401403404408409413
GET
/api/v2/intents/customerintents/{customerIntentId}/sourceintents
Get source intents mapped to a customer intent
getIntentsCustomerintentSourceintents 4 params → 200400401403404408409413
GET
/api/v2/intents/sourceintents
Get all mapped source intents by type. If no type selected default is type Segment
getIntentsSourceintents 4 params → 200400401403404408409413

Schemas 22

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

AddressableEntityRef
object
2 properties
CustomerIntentResponse
object
7 properties 3 required
CustomerIntentAssignmentListing
object
10 properties
CustomerIntentAssignmentResponse
object
3 properties
BulkResults
object
2 properties
IntentsCategoryListing
object
10 properties
Detail
object
4 properties
ErrorBody
object
11 properties
CustomerIntent
object
6 properties 4 required
BulkRemoveSourceIntentsRequest
object
1 property 1 required
CustomerSourceIntentListing
object
10 properties
IntentsCategoryPatch
object
4 properties
CustomerSourceIntent
object
2 properties
CustomerIntentAssignmentRequest
object
4 properties
DomainEntityRef
object
3 properties
Limit
object
3 properties
SourceIntent
object
5 properties
CustomerIntentListing
object
10 properties
CustomerIntentPatch
object
6 properties
IntentsCategory
object
5 properties 2 required
BulkAddSourceIntentsRequest
object
1 property 1 required
BulkSourceIntentsResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-intents-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 Intents 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.