assessment.update

post

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

Update Ashby about the status of a started assessment.

Requires the candidatesWrite permission.

assessment_status is required unless cancelled_reason is provided.

Body Params

assessment_id

uuid

required

Identifier of the assessment being updated

timestamp

int64

required

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

assessment_status

object

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

object

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

object

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

cancelled_reason

object

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

metadata

array of objects

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

metadata

Response

200

Responses for the assessment.start endpoint

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here!