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

Rules and alerts

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

15 operations 9 paths 31 schemas 3 DELETE2 GET4 PATCH4 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 Alerting 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 15

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

Alerting 15

Rules and alerts

GET
/api/v2/alerting/alerts/{alertId}
Get an alert
getAlertingAlert 1 param → 200400401403404408409413
PUT
/api/v2/alerting/alerts/{alertId}
Update an alert read status
putAlertingAlert 2 params → 200400401403404408409413
DELETE
/api/v2/alerting/alerts/{alertId}
Delete an alert
deleteAlertingAlert 1 param → 204400401403404408409413
PATCH
/api/v2/alerting/alerts/{alertId}
Allows an entity to mute/snooze an alert or update the unread status of the alert.
patchAlertingAlert 2 params → 200400401403404408409413
PATCH
/api/v2/alerting/alerts/bulk
Bulk alert updates
patchAlertingAlertsBulk 1 param → 200400401403404408409413
POST
/api/v2/alerting/alerts/query
Gets a paged list of alerts. The max page size is 50
postAlertingAlertsQuery 1 param → 200400401403404408409413
DELETE
/api/v2/alerting/alerts/all
Delete all alerts for the user
deleteAlertingAlertsAll → 200202400401403404408409
PATCH
/api/v2/alerting/alerts/all
Updates all alerts
patchAlertingAlertsAll 1 param → 200202400401403404408409
GET
/api/v2/alerting/rules/{ruleId}
Get a rule.
getAlertingRule 1 param → 200400401403404408409413
PUT
/api/v2/alerting/rules/{ruleId}
Update a rule
putAlertingRule 2 params → 200400401403404408409413
DELETE
/api/v2/alerting/rules/{ruleId}
Delete a rule.
deleteAlertingRule 1 param → 204400401403404408409413
PATCH
/api/v2/alerting/rules/bulk
Bulk update of notification lists
patchAlertingRulesBulk 1 param → 200400401403404408409413
POST
/api/v2/alerting/rules/bulk/remove
Bulk remove rules
postAlertingRulesBulkRemove 1 param → 200400401403404408409413
POST
/api/v2/alerting/rules/query
Get a paged list of rules. The max size of the page is 50 items.
postAlertingRulesQuery 1 param → 200400401403404408409413
POST
/api/v2/alerting/rules
Create a Rule.
postAlertingRules 1 param → 200201400401403404408409

Schemas 31

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

AlertRuleProperties
object
3 properties 1 required
AddressableEntityRef
object
2 properties
AlertListing
object
10 properties
CommonRuleConditions
object
4 properties 2 required
CommonAllAlertUpdateRequest
object
2 properties 1 required
AlertRequest
object
5 properties 1 required
UserReference
object
2 properties
CommonRuleBulkDeleteRequest
object
1 property 1 required
CommonRuleContainer
object
10 properties
CommonRule
object
15 properties 2 required
ModifiableRuleProperties
object
9 properties 1 required
AlertNotification
object
3 properties 2 required
ErrorBody
object
11 properties
AlertSummary
object
4 properties 3 required
GetAlertQuery
object
8 properties 2 required
BulkResponse
object
3 properties
GetRulesQuery
object
9 properties 2 required
AlertingUnreadStatus
object
1 property 1 required
UnreadFields
object
1 property 1 required
CommonRuleBulkUpdateNotificationsRequest
object
4 properties 1 required
MuteSnoozeFields
object
2 properties 2 required
CommonRulePredicate
object
9 properties 6 required
Empty
object
AlertSummaryEntity
object
6 properties 2 required
BulkResult
object
2 properties
Limit
object
3 properties
CommonAlertBulkUpdateRequest
object
4 properties 2 required
CommonAlert
object
19 properties 12 required
CommonRulePredicateEntity
object
5 properties 1 required
BulkError
object
2 properties
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-alerting-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 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
Genesys Business Rules API
AE Profile APIs.io
#Alerting
← Back to G APIs
API Details
ID
genesys:genesys-alerting-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-alerting-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-alerting-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 Alerting 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.