Skip to main content
POST
Create Scorecard

Authorizations

Authorization
string
header
required

Body

Scorecard creation payload. Title is required; teamId / allTeams / interactionType / enabled are optional.

Payload for creating a scorecard template.

title
string
required

Human-readable title of the scorecard (1-128 characters, trimmed).

teamUUID
string

UUID of the team to assign the scorecard to. Mutually exclusive with allTeams=true. Omit both for an unassigned scorecard.

allTeams
boolean
default:false

Assign the scorecard to every team in the organization. Mutually exclusive with teamId.

enabled
boolean
default:true

Whether the scorecard is active after creation.

interactionType
enum<string>

Type of interaction the scorecard evaluates.

Available options:
conversation,
chat,
email
Example:

"conversation"

detailedInstructions
string

Optional free-form guidance (0-2000 characters).

scorecardPrompt
string

Optional prompt override for expert mode (0-8000 characters).

expertMode
boolean
default:false

Whether the scorecard uses custom prompts instead of the default template.

criteria
object

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

Example:

Response

Scorecard successfully created

Single-resource envelope wrapping a Scorecard.

data
object
required

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

Example: