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

Bright Pattern Methods API

The Methods API from Bright Pattern — 32 operation(s) for methods.

Bright Pattern Methods API is one of 14 APIs that Bright Pattern publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 34 operations across 32 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant_url}.

34 operations 32 paths 0 schemas 1 DELETE24 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{tenant}.brightpattern.com/configapi/v2
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bright Pattern Methods API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token issued by the Bright Pattern token endpoint, sent as Authorization: Bearer .
  • oauth2ClientCredentials — OAuth 2.0 client-credentials grant against the Bright Pattern tenant token endpoint.

Paths & Operations 34

Across 32 paths, the API surfaces 34 operations — 1 DELETE, 24 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Methods 34
GET
/clientweb/api/v1/availability
Check Availability
checkAvailability 2 params → 200
GET
/clientweb/api/v1/parameters
Expected Parameters
expectedParameters 2 params → 200
POST
/clientweb/api/v1/chats
Request Chat
requestChat 3 params body → 200
GET
/clientweb/api/v1/chats/active
Get Active Chat
getActiveChat 2 params → 200
POST
/clientweb/api/v1/chats/{chatId}/events
Send Events
sendEvents 3 params body → 200
GET
/clientweb/api/v1/chats/{chatId}/events
Get New Chat Events
getNewChatEvents 3 params → 200
GET
/clientweb/api/v1/chats/{chatId}/history
Get Chat History
getChatHistory 3 params → 200
POST
/clientweb/api/v1/files
Upload File
uploadFile 2 params body → 200
GET
/clientweb/api/v1/chats/{chatId}/files/{fileId}
Get File
getFile 2 params → 200
GET
/clientweb/api/v1/chats/{chatId}/profilephotos/{partyId}
Get Agent Profile Photo
getAgentProfilePhoto 2 params → 200
GET
/clientweb/api/v1/iceservers
Get ICE servers
getIceServers 2 params → 200
GET
/clientweb/api/v1/configuration
Get Chat Widget Configuration
getChatWidgetConfiguration 2 params → 200
GET
/clientweb/api/v2/availability
Check Availability
checkAvailability 2 params → 200
GET
/clientweb/api/v2/parameters
Expected Parameters
expectedParameters 2 params → 200
POST
/clientweb/api/v2/chats
Request Chat
requestChat 3 params body → 200
POST
/clientweb/api/v2/chats/{chatId}/notifications
Mobile Notification Subscription
mobileNotificationSubscription 3 params body → 200
GET
/clientweb/api/v2/chats/active
Get Active Chat
getActiveChat 2 params → 200
POST
/clientweb/api/v2/chats/{chatId}/events
Send Events
sendEvents 3 params body → 200
GET
/clientweb/api/v2/chats/{chatId}/events
Get New Chat Events
getNewChatEvents 3 params → 200
GET
/clientweb/api/v2/chats/{chatId}/history
Get Chat History
getChatHistory 3 params → 200
POST
/clientweb/api/v2/files
Upload File
uploadFile 2 params body → 200
GET
/clientweb/api/v2/chats/{chatId}/files/{fileId}
Get File
getFile 2 params → 200
GET
/clientweb/api/v2/chats/{chatId}/profilephotos/{partyId}
Get Agent Profile Photo
getAgentProfilePhoto 2 params → 200
GET
/clientweb/api/v2/iceservers
Get ICE servers
getIceServers 2 params → 200
GET
/clientweb/api/v2/configuration
Get Chat Widget Configuration
getChatWidgetConfiguration 2 params → 200
GET
/clientweb/api/v2/casehistory
Get Case History
getCaseHistory 2 params → 200
POST
/clientweb/api/v2/closecase
Close Case
closeCase 2 params → 200
GET
/clientweb/api/v2/version
Get Version
getVersion 2 params → 200
POST
/statsapi/subscription
Create Subscription
createSubscription body → 200
GET
/statsapi/subscription/data
Get Subscription Data
getSubscriptionData → 200
DELETE
/statsapi/subscription/active
Delete Subscription
deleteSubscription → 200
GET
/statsapi/cfg/dispositions
Get Dispositions
getDispositions → 200
GET
/statsapi/info/check_available_agents
Get Available Agents
getAvailableAgents 1 param → 200
GET
/statsapi/cfg/teams
Get Teams
getTeams → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bright-pattern-methods-api-openapi.yml Raw ↑

Other APIs Bright Pattern publishes across the network.

Bright Pattern Authentication API
Bright Pattern Calling List API
Bright Pattern Campaigns API
Bright Pattern DNC Lists API
Bright Pattern Do Not Call List API
Bright Pattern Link Groups API
Bright Pattern Lists API
Bright Pattern Multichannel Call Recordings API
Bright Pattern Phones API
Bright Pattern Regular Call Recordings API
Bright Pattern SMS/MMS Messaging API
Bright Pattern Task Routing API
Where this information came from

This is an independent, third-party profile of Bright Pattern Methods 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.