v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB

Scorecard

Update Scorecard

Partially updates a scorecard. Only fields present in the request body are modified; omitted fields retain their current values. Requires an org-scoped API key.

patch/scorecards/{id}

Path parameters

idstring required

Scorecard UUID

Request body

titlestring

Replacement title (1-128 characters, trimmed).

teamUUIDstring

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

allTeamsboolean nullable

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

enabledboolean nullable

Toggle the scorecard active state.

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

Type of interaction the scorecard evaluates.

detailedInstructionsstring

Replacement detailed instructions (0-2000 characters).

scorecardPromptstring

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

expertModeboolean nullable

Toggle expert mode.

Example request

{
  "title": "Sales Discovery Scorecard (v2)",
  "enabled": false
}

Response

Scorecard successfully updated

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"
  }
}