Skip to content
vocapable.Docs

Turn QA or AI QA on/off (owner; AI QA needs the policy)

PUT
/v1/workspace/quality/settings
curl --request PUT \
  --url https://api.vocapable.com/v1/workspace/quality/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_revision": 1, "qa_enabled": true, "ack_window_days": 1, "ai_qa_enabled": true, "accept_ai_policy_version": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
QualitySettingsUpdate
object
expected_revision
required
Expected Revision
integer
qa_enabled
Any of:
boolean
ack_window_days
Any of:
integer
>= 1 <= 30
ai_qa_enabled
Any of:
boolean
accept_ai_policy_version
Any of:
string
<= 40 characters
Examplegenerated
{
  "expected_revision": 1,
  "qa_enabled": true,
  "ack_window_days": 1,
  "ai_qa_enabled": true,
  "accept_ai_policy_version": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
QualitySettings
object
features
required
QualityFeatures

The staff-owned switches as they apply to this company right now.

object
contact_center
required
Contact Center
boolean
quality
required
Quality
boolean
ai_qa
required
Ai Qa
boolean
qa_enabled
required
Qa Enabled
boolean
ack_window_days
required
Ack Window Days
integer
ai_qa_enabled
required
Ai Qa Enabled
boolean
ai_policy
required
QualityAiPolicy
object
version
required
Version
string
text
required
Text
string
ai_policy_accepted_version
required
Any of:
string
ai_policy_accepted_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
ai_policy_accepted_at
required
Any of:
string format: date-time
ai_policy_current
required
Ai Policy Current
boolean
thresholds
required
QualityThresholds

The PRD numbers the product applies (shown in-product with their reason).

object
min_calibrated_calls
required
Min Calibrated Calls
integer
min_agreement
required
Min Agreement
number
scoring_deadline_minutes
required
Scoring Deadline Minutes
integer
dispute_window_days
required
Dispute Window Days
integer
dispute_resolution_business_days
required
Dispute Resolution Business Days
integer
recompute_interval_days
required
Recompute Interval Days
integer
agreement_computed_at
required
Any of:
string format: date-time
can_edit
required
Can Edit
boolean
can_evaluate
required
Can Evaluate
boolean
revision
required
Revision
integer
can_evaluate_conversations
Can Evaluate Conversations
boolean
ai_scoring
Any of:
QualityAiScoringHealth

The AI scoring deadline as measured (PRD CC5-R3: every eligible call scored within 15 minutes of its transcript being final). Owners and supervisors see it; the owners are pushed quality.scoring_overdue when a call waits past the deadline unscored.

object
deadline_minutes
required
Deadline Minutes
integer
overdue
required
Overdue
integer
oldest_overdue_final_at
required
Any of:
string format: date-time
scored_7d
required
Scored 7D
integer
late_7d
required
Late 7D
integer
last_alert_at
required
Any of:
string format: date-time
Example
{
  "can_evaluate_conversations": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}