Skip to main content
POST
Create scorecard template

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Template name shown to raters (required).

Minimum string length: 1
description
string

Optional template description.

job_id
string<uuid>

Job UUID to scope this template to. Only one active template can exist per job. Omit to create an org-wide template.

rating_scale
integer
default:5

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

enable_ai_auto_grade
boolean
default:false

When true, the AI copilot can auto-grade candidates against this template. Defaults to false.

overall_default_text
string

Default note text pre-filled in the overall summary section. Plain text only.

team_member_id
string<uuid>

Team member UUID to record as the template creator. Defaults to the caller. Required when the caller is authenticated with an API key (no team member context).

criteria
object[]

Criteria to attach to the template. Each criterion has a name and optional description, importance, position, and default_text. When position is omitted, criteria are numbered in the order provided.

Response

Scorecard template created

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