assessment.update

post

https://api.ashbyhq.com/assessment.update

Update Ashby about the status of a started assessment.

assessment_status is required unless cancelled_reason is provided.

Requires the candidatesWrite permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

assessment_id

string

required

Identifier of the assessment being updated

timestamp

number

required

The timestamp in milliseconds since the unix epoch when the assessment update occurred

assessment_status

AssessmentDataValue | null

The current status of the assessment. Setting this with a value of "Started" will signal Ashby to store the timestamp the assessment started. Required when cancelled_reason is not set.

assessment_profile_url

AssessmentDataValue | null

The url back to the assessment/candidate on the partner's website. This value should always be of type url. Required when assessment_result is set.

assessment_result

AssessmentDataValue | null

The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete.

cancelled_reason

AssessmentDataValue | null

The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled.

metadata

array | null

Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.

Response

Language

Credentials

Basic

base64

Loading…

Response

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

application/json

200Responses from the assessment.update endpoint