Sign in

v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
assessment
order

Update an order

put/assessment/{connection_id}/order/{id}

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Order

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time
updated_atstring date-time
workspace_idstring required
connection_idstring required
webhook_idstring
package_idstring
target_urlstring
status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
referencestring
application_idstring
job_idstring
company_idstring
candidate_idstring
employee_idstring
profile_namestring
profile_first_namestring
profile_last_namestring
profile_resume_urlstring
profile_ip_addressstring
profile_date_of_birthstring
profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
profile_social_media_urlsstring[]
response_completed_atstring date-time
response_expires_atstring date-time
response_issued_atstring date-time
response_status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
response_scorenumber
response_max_scorenumber
response_urlstring
response_redirect_urlstring
response_download_urlsstring[]

Report download URLs

response_sourcestring
rawobject

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
workspace_idstring required
connection_idstring required
webhook_idstring
package_idstring
target_urlstring
status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
referencestring
application_idstring
job_idstring
company_idstring
candidate_idstring
employee_idstring
profile_namestring
profile_first_namestring
profile_last_namestring
profile_resume_urlstring
profile_ip_addressstring
profile_date_of_birthstring
profile_gender'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
profile_emailsstring[]
profile_telephonesstring[]
profile_national_identifierstring
profile_social_media_urlsstring[]
response_completed_atstring date-time
response_expires_atstring date-time
response_issued_atstring date-time
response_status'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
response_scorenumber
response_max_scorenumber
response_urlstring
response_redirect_urlstring
response_download_urlsstring[]

Report download URLs

response_sourcestring
rawobject