Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Scorecard

Create Scorecard

Creates a new scorecard template in the caller's organization. Requires an org-scoped API key (admin-equivalent). The new scorecard has no items on creation — use POST /scorecards/{id}/items to add scoring criteria.

post/scorecards

Request body

titlestring required

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

teamUUIDstring

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

allTeamsboolean

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

enabledboolean

Whether the scorecard is active after creation.

interactionType'conversation' | 'chat' | 'email'

Type of interaction the scorecard evaluates.

detailedInstructionsstring

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

scorecardPromptstring

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

expertModeboolean

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

Example request

{
  "title": "Sales Discovery Scorecard",
  "allTeams": true,
  "enabled": true,
  "interactionType": "conversation",
  "detailedInstructions": "Evaluate discovery quality.",
  "expertMode": false
}

Response

Scorecard successfully created

Example response

{
  "data": {
    "id": "sc-uuid-123",
    "title": "Sales Discovery Scorecard",
    "organizationId": "org-uuid-456",
    "allTeams": true,
    "enabled": true,
    "interactionType": "conversation",
    "expertMode": false,
    "isDefaultTemplate": false,
    "createdAt": "2026-04-16T10:15:00Z"
  }
}