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 result content is carried in blocks, and the array's order is the order Breezy renders
it in. Every block type may appear any number of times, and blocks may be empty or omitted
while results are pending.

A write replaces the entire blocks array. Blocks carry no identity, so nothing is
merged: each write must state the complete result body as of that moment. A request that
omits blocks clears any blocks stored previously.

Blocks are structured values only. Breezy owns every presentation decision — bar
proportions, ring geometry, severity icon and color — so no markup, styling or imagery can
be supplied through this endpoint.

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

Request body for POST /v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/assessments. Identity and lifecycle fields plus an ordered blocks array holding all result content. A write replaces the entire blocks array.

string
required
length between 1 and 128

The writer's own identifier for this assessment. Upsert key together with the authenticated provider identity.

string
required
length between 1 and 200

Assessment name shown on the card.

string
enum
required

Lifecycle status.

Allowed:
string | null

Unverified display name for the writer. Verified branding comes from the authenticated partner key, never from the body.

string | null

ISO 8601 date-time. Timestamps are stored as sent and are not validated against one another.

string | null

ISO 8601 date-time. Timestamps are stored as sent and are not validated against one another.

string | null

ISO 8601 date-time. Timestamps are stored as sent and are not validated against one another.

blocks
array of objects
length ≤ 20

Ordered result content. Array order is render order. Every block type may appear any number of times. May be empty or absent.

blocks
Responses

400

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

401

Unauthorized

403

Assessments feature not available on current plan

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