Create a new quality scorecard

`POST /quality/scorecard`

Creates a new quality scorecard. Requires qualityManageScorecards permission.

Request body

Provide the complete scorecard payload as JSON.

namestringbodyrequired

Name of the scorecard

stateenumbodyDefault: active

State of the new scorecard (defaults to active if omitted) Options: draft, active

categoriesobject[]bodyrequired

Categories with nested criteria definitions

assignmentobjectbody

Assignment rules (optional). Omitted fields default to empty (no filter).

liveCoachobjectbody

Live Quality Coach configuration (optional, defaults to disabled)

Request Example

{
  "name": "Junior agent standard review",
  "state": "active",
  "categories": [
    {
      "categoryId": 1,
      "label": "Opening",
      "order": 1,
      "criteria": [
        {
          "id": 10,
          "label": "Greeting",
          "description": "Did the agent greet the customer properly?",
          "maxPoints": 5,
          "scoringType": "numericScale",
          "autoGenerateByAi": false,
          "assessmentPrompt": "Evaluate the opening.",
          "makeOrBreakForCategory": false,
          "makeOrBreakForAssessment": false
        }
      ]
    }
  ],
  "assignment": {
    "ticketTags": [
      101,
      102
    ],
    "teams": [
      5,
      7
    ],
    "channels": [
      "email"
    ],
    "responseContexts": [
      "afterCustomerMessage"
    ],
    "excludeTeams": [
      9
    ]
  },
  "liveCoach": {
    "enabled": true,
    "threshold": 80
  }
}

Responses

200 — Scorecard created successfully

Response Example

{
  "id": 1,
  "baseId": 1
}

400 — Bad request (e.g., missing required fields)

403 — Unauthorized (missing qualityManageScorecards permission)

500 — Internal error