scorecard

Create scorecard record

Create scorecard record with given parameters

post/create/scorecard

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/create/scorecard
  • Auth
    none declared

Request body multipart/form-data

scorecard_titlestring required

Title of the scorecard

scorecard_outcome_labelstring required

Outcome label for the scorecard

ai_outcomestring

Whether AI outcome is enabled ("true" or "false")

outcome_indicator_idstring

Outcome indicator ID (If ai_outcome is true, this field is required)

total_score_outcomestring

Whether to use total score outcome ("true" or "false")

has_sectionsstring required

Whether the scorecard has sections ("true" or "false")

group_liststring required

JSON-stringified array of group IDs assigned to the scorecard

default_groupsstring

JSON-stringified array of default group IDs

org_unit_idstring required

Organization unit ID (as string )

indicator_liststring required

JSON-stringified array of objects which consists of indicator_id, section_id (add section_id if has_sections is true)

isDuplicatestring required

Indicates if this is a duplicate scorecard ("true" or "false")

scorecard_sectionsstring

JSON-stringified array of objects which consist of name(string), weight(number), hideIndicators(boolean), display_order(number) scorecard sections (required if has_sections is true)

filestring binary

File to upload as scorecard instructions (optional)

total_score_thresholdstring

Total score threshold (if total_score_outcome is true) (as string/number)

defaultGroupChangestring

Indicates if default group changed ("true" or "false")

removeGroupAssociationstring

JSON-stringified array of group associations to remove (optional)

rescoreCallsstring

Whether to rescore calls ("true" or "false")

original_scorecard_idstring

Original scorecard ID for rescoring (optional)

rescoreRangestring

JSON-stringified object with start/end dates for rescoring (optional)

Response

The result of the submission and scorecard_id for the newly added scorecard.

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

errstring required

Error message when result='error'. String. Empty/null on success.

datastring

Response payload. Shape varies by endpoint.

Changes

No recorded changes to this operation across all 2 revisions of this API.