Update Scorecard

This guide describes how to use the Update Scorecard Management API.

This guide describes how to use the Management API Update Scorecard operation to change Scorecard properties by providing the scorecard ID, criteria ID, and name of the scorecard. You can replace, update, or remove individual entities, without updating the rest of the scorecard.

Authentication

Before using this API, you must generate your authentication token (AUTH_TOKEN) as described in Authenticate.

Use cases

Modify scorecard criteria based on recent performance analysis.
Refine scorecard to address feedback from evaluators and agents.
Adjust scorecard priorities to adapt to seasonal changes.
Update scorecard to include new training program outcomes.

Request parameters

Parameter	Required	Description
Name	Yes	The name of the scorecard being updated. It should be descriptive and easily identifiable.
CriteriaList	Yes	The unique identifier(s) of the criteria that the scorecard will use for evaluating conversations. This ensures that the correct criteria are applied.
Tags	Optional	Tags can be used to categorize or organize the scorecard for easier management and retrieval.

Update Scorecard
Updating a scorecard can be done using both PUT and PATCH endpoints.

Here is the PUT API request to update a scorecard:

PUT https://api.symbl.ai/v1/manage/callscore/scorecards/{scorecardId}

{
    "name": "Scorecard Test",
    "tags": [
        "Test",
        "Scorecard"
    ],
    "criteriaList": [
        "5076324933173248",
        "5279029135933440",
        "Symbl.Communication_And_Engagement"
    ]
}

Sample Response

{
    "id": "589523423829343",
    "name": "Scorecard Test",
    "tags": [
        "Test",
        "Scorecard"
    ],
    "criteriaList": [
        "5076324933173248",
        "5279029135933440",
        "Symbl.Communication_And_Engagement"
    ]
}

Here is the PATCH API request to update a scorecard:

PATCH https://api.symbl.ai/v1/manage/callscore/scorecards/{scorecardId}

[
    {
        "op": "replace",
        "path": "/name",
        "value": "Scorecard with PATCH Operation"
    },
    {
        "op": "replace",
        "path": "/tags",
        "value": [
            "PATCH"
        ]
    },
    {
        "op": "replace",
        "path": "/criteriaList",
        "value": [
            "5386289770135552",
            "5076324933173248",
            "5279029135933440",
            "Symbl.Communication_And_Engagement"
        ]
    }
]

Sample Response

{
 "name": "Scorecard with PATCH Operation",
 "tags": ["tag-1", "tag-2", "tag-3"],
 "description": "PATCH Operation",
 "id": "4782752799653888",
 "criteriaList": [
						"5386289770135552",
            "5076324933173248",
            "5279029135933440",
            "Symbl.Communication_And_Engagement"
	]
}

Updated about 2 months ago