Update assessment status

patch

https://api.hibob.com/v1/hiring/assessments/{assessmentRequestId}

Report status, score, verdict, result URL, and section breakdown back to Bob.

Reports status changes and optional results for an existing assessment.
The assessment ID is always in the path — assessmentRequestId is not
accepted in the body.

status is required on every PATCH. providerAssessmentId, score,
verdict, resultUrl, sectionSummary, and comments are optional.
Omitted optional fields keep previously stored values.

status is a single combined enum (process + outcome) matching the Bob UI
and first-party provider contract. completed means the process finished
without a pass/fail outcome; passed and failed are terminal outcomes.
Use optional verdict as a separate free-text outcome channel.

After an assessment.cancelled webhook, partners stop processing and do not
send further updates unless product guidance says otherwise.

A successful PATCH always returns 204. Bob accepts the payload and applies
it asynchronously, including same-status updates that still change result
fields. 304 is not returned.

Result URL lifecycle (resultUrl): Partners may host results on their
own site. Supply an HTTPS URL; Bob stores the URL only and does not fetch
the page. File upload into Bob is out of scope for v1.

400 is returned when status is unsupported or
resultUrl is not a valid HTTPS URL.

OAuth scope: hiring.integrations:write

Rate limit: default partner API / API gateway limits. See
Rate limiting.

Path Params

assessmentRequestId

string

required

Numeric Bob assessment ID as a string.

Body Params

Status update payload. status is required; result fields are optional.

status

string

enum

required

Overall assessment status shown in Bob. Required on every update.

Allowed:

providerAssessmentId

int64 | null

Partner's own assessment reference stored on the assessment. Optional;
may be set or updated on later PATCH calls.

score

float | null

Overall numeric score from the partner. Optional; no fixed range in v1.

verdict

string | null

Optional free-text / partner verdict channel (for example "passed").
Not the same as status and not an enum in v1.

resultUrl

string | null

^https://.+

HTTPS URL to results on the partner site. Bob stores the URL only and
does not fetch the page. HTTPS only.

sectionSummary

array of objects | null

Optional per-section score breakdown from the partner.

sectionSummary

comments

array of strings | null

Optional free-text notes from the partner. Array of strings; no fixed
vocabulary.

comments

Responses

204

No content

Language

Credentials

Bearer

OAuth 2.0

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request — the request body failed validation. See the operation description for the fields validated on that endpoint.

401Unauthorized — the OAuth 2.0 access token is missing, invalid, or expired.

403Forbidden — the authenticated partner app does not have the hiring.integrations:write scope.

404Not found — no assessment exists for the given assessmentRequestId in the installing company for this partner provider, the assessment integration is not available for the installing company, or required assessment context (for example the requester) is unavailable.

429Too many requests — rate limit exceeded. Retry after the delay indicated by the platform partner API / API gateway defaults.

500Internal server error — an unexpected error occurred. Retry with exponential backoff; if the error persists, contact HiBob support with the request_id from the response body.