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 Users Rules API

Create and manage users rules and their dependents

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

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

This API exposes 9 operations across 6 paths, and defines 20 schemas. It is described by OpenAPI 2.0, at version v2.

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

9 operations 6 paths 20 schemas 1 DELETE5 GET1 PATCH2 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 Users Rules 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 9

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

Users Rules 9

Create and manage users rules and their dependents

GET
/api/v2/users/rules/{ruleId}/dependents
Get dependents for a users rule
getUsersRuleDependents 4 params → 200400401403404408409413
GET
/api/v2/users/rules/{ruleId}/dependents/{ruleType}/{typeId}
Get dependent of a users rule
getUsersRuleDependentTypeId 3 params → 200400401403404408409413
GET
/api/v2/users/rules/{ruleId}
Get a users rule
getUsersRule 1 param → 200400401403404408409413
DELETE
/api/v2/users/rules/{ruleId}
Delete an existing users rule
deleteUsersRule 1 param → 204400401403404408409413
PATCH
/api/v2/users/rules/{ruleId}
Update an existing users rule
patchUsersRule 2 params → 200400401403404408409413
GET
/api/v2/users/rules
Get the list of users rules
getUsersRules 7 params → 200400401403404408409413
POST
/api/v2/users/rules
Create a new rule
postUsersRules 1 param → 200400401403404408409413
POST
/api/v2/users/rules/query
Query the result of a users rule
postUsersRulesQuery 3 params → 200400401403404408409413
GET
/api/v2/users/rules/settings/{ruleType}
Get the settings for a specific users rule type
getUsersRulesSetting 1 param → 200400401403404408409413

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are UsersRulesRule (13 properties), ErrorBody (11 properties), UsersRulesDependentList (10 properties), UsersRulesRuleList (10 properties). Each schema is shown below with its type and property counts.

UsersRulesCreateRuleRequest
object
Create users rule request
4 properties 3 required
UserReference
object
2 properties
UsersRulesRuleList
object
10 properties
UsersRulesQueryResponse
object
6 properties
UsersRulesCriteria
object
3 properties 2 required
UsersRulesRule
object
Users rule response
13 properties
ErrorBody
object
11 properties
UsersRulesQueryRuleRequest
object
Users query rule request
3 properties 3 required
UsersRulesLastRunMetadata
object
4 properties
UsersRulesGroupItem
object
4 properties 3 required
UsersRulesDependentList
object
10 properties
UsersRulesRuleSettings
object
Users rule type-specific settings response
2 properties
UsersRulesUpdateRuleRequest
object
Update users rule request
4 properties
UsersRulesDependentRule
object
Users rule response
2 properties
Limit
object
3 properties
UsersRulesValue
object
2 properties 1 required
UsersRulesLockedCriteriaSettingsCriteria
object
2 properties 2 required
UsersRulesDependent
object
Users rule dependent response
8 properties
UsersRulesLockedCriteriaSettingsGroup
object
3 properties 2 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-users-rules-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 Users Rules 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.