Create Scorecard

Creates a new scorecard with specified configuration, sections, and indicators.

Required Fields

scorecard_title — Unique title within the billing account

scorecard_outcome_label — Label for the scorecard outcome (e.g., "Pass/Fail")

has_sections — Whether the scorecard uses sections

applied_to_groups — Array of org unit IDs that have access to this scorecard

org_unit_id — Org unit where the scorecard is created

indicator_list — Array of indicators with configurations

is_duplicate — Flag indicating if this is a duplicate (typically false for new scorecards)

Conditional Requirements

If ai_outcome = true, then outcome_indicator_id is required

If total_score_outcome = true, then total_score_threshold is required

If has_sections = true, then scorecard_sections array is required

If has_sections = true, each indicator must have a section_id (array index of the section)

Indicator Configuration
Each indicator in indicator_list must include:

indicator_id — ID of an existing active indicator

scorecard_indicator_title — Display title for this indicator

section_id — Index in scorecard_sections array (required if has_sections = true)

Optional: importance, is_required, allow_na, display_order, indicator_sign, help_text

Section Configuration
If has_sections = true, each section in scorecard_sections must include:

name — Section name

display_order — Display order

weight — Section importance/weight

Optional: hideIndicators or hide_indicators

Optional: Rescore Historical Calls
To rescore historical calls after scorecard creation:

rescoreCalls — Set to true to enable rescoring (default: false)

original_scorecard_id — ID of the scorecard being replaced (required if rescoreCalls = true)

rescoreRange — Object with start and end dates in YYYY-MM-DD format (required if rescoreCalls = true)

Rescore jobs are published to RabbitMQ queue for background processing

Only triggers if scorecard_status = "active" and rescoreCalls = true

Fire-and-forget operation — scorecard creation succeeds even if queue publish fails

Access Control

Requires Admin role

All applied_to_groups and default_groups org_unit_ids must belong to the user's billing account

Scorecard title must be unique within the billing account

Example Request

{
  "scorecard_title": "Sales Quality Scorecard",
  "scorecard_outcome_label": "Pass/Fail",
  "has_sections": true,
  "org_unit_id": 70035,
  "applied_to_groups": [70035, 70292],
  "default_groups": [70035],
  "is_duplicate": false,
  "ai_outcome": false,
  "total_score_outcome": false,
  "scorecard_sections": [
    {"name": "Quality Metrics", "display_order": 1, "weight": 5, "hideIndicators": false}
  ],
  "indicator_list": [
    {
      "indicator_id": 123,
      "scorecard_indicator_title": "Greeting Quality",
      "section_id": "0",
      "importance": 5,
      "is_required": false,
      "allow_na": false,
      "display_order": 1,
      "indicator_sign": "positive"
    }
  ]
}

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://platform-api.convirza.com/v3/scorecards/create' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "scorecard_title": "Basic Quality Scorecard", "scorecard_outcome_label": "Pass/Fail", "has_sections": false, "org_unit_id": 70035, "applied_to_groups": [ 70035, 70292 ], "is_duplicate": false, "indicator_list": [ { "indicator_id": 123, "scorecard_indicator_title": "Greeting Quality", "importance": 5, "is_required": false, "allow_na": false, "display_order": 1, "indicator_sign": "positive" } ] }'

Create Scorecard

Request

Responses