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

Persist settings

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

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

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

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

14 operations 5 paths 13 schemas 3 DELETE5 GET4 PATCH2 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 Settings 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 14

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

Settings 14

Persist settings

GET
/api/v2/users/agentui/agents/autoanswer/{agentId}/settings
Get agent auto answer settings
getUsersAgentuiAgentsAutoanswerAgentIdSettings 1 param → 200400401403404408409413
PUT
/api/v2/users/agentui/agents/autoanswer/{agentId}/settings
Set agent auto answer settings
putUsersAgentuiAgentsAutoanswerAgentIdSettings 2 params → 200400401403404408409413
DELETE
/api/v2/users/agentui/agents/autoanswer/{agentId}/settings
Delete agent auto answer settings
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings 1 param → 204400401403404408409413
PATCH
/api/v2/users/agentui/agents/autoanswer/{agentId}/settings
Update agent auto answer settings
patchUsersAgentuiAgentsAutoanswerAgentIdSettings 2 params → 200400401403404408409413
GET
/api/v2/emails/settings
Get email Contact Center settings
getEmailsSettings → 200400401403404408409413
PATCH
/api/v2/emails/settings
Patch email Contact Center settings
patchEmailsSettings 1 param → 200400401403404408409413
GET
/api/v2/emails/settings/threading
Get email threading settings
getEmailsSettingsThreading → 200400401403404408409413
DELETE
/api/v2/emails/settings/threading
Reset email threading settings to default
deleteEmailsSettingsThreading → 204400401403404408409413
PATCH
/api/v2/emails/settings/threading
Patch email threading settings
patchEmailsSettingsThreading 1 param → 200400401403404408409413
GET
/api/v2/settings/executiondata
Get the execution history enabled setting.
getSettingsExecutiondata → 200400401403404408409413
PATCH
/api/v2/settings/executiondata
Edit the execution history on off setting.
patchSettingsExecutiondata 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/settings
Get settings
getExternalcontactsSettings → 200400401403404408409413
PUT
/api/v2/externalcontacts/settings
Set settings
putExternalcontactsSettings 1 param → 200202400401403404408409
DELETE
/api/v2/externalcontacts/settings
Delete settings
deleteExternalcontactsSettings → 200204400401403404408409

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ErrorBody (11 properties), ExecutionDataGlobalSettingsResponse (7 properties), Detail (4 properties), Limit (3 properties). Each schema is shown below with its type and property counts.

ExecutionDataGlobalSettingsResponse
object
7 properties
ExternalContactsSettings
object
2 properties
ErrorBody
object
11 properties
DomainEntityRef
object
3 properties
EmailThreadingSettings
object
2 properties
UserReference
object
2 properties
AutoAnswerSettings
object
1 property 1 required
AutoAnswerSetting
object
1 property 1 required
EmailSettings
object
1 property
Limit
object
3 properties
UpdatedSettingsResponse
object
1 property
ExecutionDataSettingsRequest
object
1 property 1 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-settings-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 Settings 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.