Create or update a candidate assessment result

Upserts an assessment keyed on (provider_type, external_id) for the candidate-position.
When authenticated with a partner API key, provider_type is set from the partner registry
and provider_name in the body is ignored. Customer tokens may set provider_name when no
partner key is present. All content blocks are optional except identity fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
string
required
Body Params
string
required
length ≤ 128

Partner-assigned stable identifier for this assessment instance

string
required
length ≤ 200
string
enum
required
Allowed:
score
object
sections
array of objects
length ≤ 50
sections
string
length ≤ 2000
details
array of objects
length ≤ 20
details
links
array of objects
length ≤ 3
date-time
date-time
date-time
string
length ≤ 60

Display name when not using a verified partner API key

Responses

400

Validation error (unknown fields, invalid status, non-https links, etc.)

401

Unauthorized

403

Assessments feature not available on current plan

412

Candidate is not on requested position

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json