Skip to main content
PATCH
Update Scorecard

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Scorecard UUID

Body

Fields to update. All fields are optional; at least one must be provided.

Partial update payload for a scorecard. All fields are optional; at least one must be present.

title
string

Replacement title (1-128 characters, trimmed).

teamUUID
string

Reassign the scorecard to a specific team. Mutually exclusive with allTeams=true.

allTeams
boolean | null

Reassign the scorecard to every team. Mutually exclusive with teamId.

enabled
boolean | null

Toggle the scorecard active state.

interactionType
enum<string>

Type of interaction the scorecard evaluates.

Available options:
conversation,
chat,
email
Example:

"conversation"

detailedInstructions
string

Replacement detailed instructions (0-2000 characters).

scorecardPrompt
string

Replacement expert-mode prompt (0-8000 characters).

expertMode
boolean | null

Toggle expert mode.

criteria
object

Label-based criteria that gate when a scorecard is applied to an interaction.

Example:

Response

Scorecard successfully updated

Single-resource envelope wrapping a Scorecard.

data
object
required

A scorecard template used to evaluate a conversation, chat, or email.

Example: