Skip to main content
PATCH
Update scorecard template

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Scorecard template ID

Body

application/json
name
string

Template name shown to raters.

Minimum string length: 1
description
string | null

Optional template description. Pass null to clear.

job_id
string<uuid> | null

Job UUID to scope the template to. Pass null to make org-wide. Only one active template can exist per job.

rating_scale
integer

Star rating scale. Must be one of: 3, 4, 5, or 10.

enable_ai_auto_grade
boolean

Toggle AI auto-grading for this template.

is_archived
boolean

Archive or unarchive the template.

overall_default_text
string | null

Default overall summary text. Plain text only. Pass null to clear.

team_member_id
string<uuid>

Team member UUID to record as the last_updated_by. Defaults to the caller.

criteria
object[]

When provided, REPLACES the active criteria set: existing non-archived criteria are archived (preserving historical ratings) and these new criteria are inserted. Omit to leave criteria unchanged.

Response

Scorecard template updated

success
enum<boolean>
required
Available options:
true
data
object
required