--- title: "Update an order" url: "https://docs.unified.to/assessment/order/Update_an_order" description: "API reference for Update an order. Launch multiple pre-built Order integrations today with zero maintenance — all through a single API." generated_at: "2026-06-24T17:14:08.744Z" --- # Update an order PUT/assessment/{connection\_id}/order/{id} ## Parameters **fields**string array id created\_at updated\_at workspace\_id connection\_id webhook\_id package\_id parameters target\_url status reference application\_id job\_id company\_id candidate\_id employee\_id profile\_name profile\_first\_name profile\_last\_name profile\_resume\_url profile\_ip\_address profile\_date\_of\_birth profile\_addresses profile\_gender profile\_emails profile\_telephones profile\_national\_identifier profile\_social\_media\_urls response\_completed\_at response\_expires\_at response\_issued\_at response\_status response\_score response\_max\_score response\_url response\_redirect\_url response\_download\_urls response\_details response\_source response\_attributes raw Fields to return **raw**string 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 **connection\_id**string required ID of the connection **id**string required ID of the Order ## Payload **id**string **created\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **workspace\_id**string required Workspace ID that this order belongs to (reference to KmsSpace) **connection\_id**string required Connection ID that this order belongs to **webhook\_id**string Webhook ID that this order belongs to **package\_id**string Assessment package ID **parameters** array Filled-in answers to the package's parameter questions **target\_url**string URL to redirect user to after assessment **status** enum Valid values: "OPEN" "IN\_PROGRESS" "COMPLETED" "FAILED" "REJECTED" **reference**string ATS-specific reference ID **application\_id**string ATS application ID **job\_id**string ATS job ID **company\_id**string ATS company ID (reference to AtsCompany) **candidate\_id**string ATS candidate ID **employee\_id**string ATS employee ID **profile\_name**string **profile\_first\_name**string **profile\_last\_name**string **profile\_resume\_url**string **profile\_ip\_address**string XXX.XXX.XXX.XXX **profile\_date\_of\_birth**string YYYY-MM-DD **profile\_addresses** array **profile\_gender** enum Valid values: "MALE" "FEMALE" "INTERSEX" "TRANS" "NON\_BINARY" **profile\_emails**string array **profile\_telephones**string array **profile\_national\_identifier**string **profile\_social\_media\_urls**string array **response\_completed\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_expires\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_issued\_at**date Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_status** enum Valid values: "OPEN" "IN\_PROGRESS" "COMPLETED" "FAILED" "REJECTED" **response\_score**number Assessment score (e.g., 0-100) **response\_max\_score**number Maximum possible score **response\_url**string URL to view detailed results **response\_redirect\_url**string URL to redirect the user to complete assessment **response\_download\_urls**string array Report download URLs **response\_details** array **response\_source**string **response\_attributes** array Additional result attributes **raw**any ## Returns [AssessmentOrder](/assessment/order/model) **id**string **created\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **workspace\_id**string required Workspace ID that this order belongs to (reference to KmsSpace) **connection\_id**string required Connection ID that this order belongs to **webhook\_id**string Webhook ID that this order belongs to **package\_id**string Assessment package ID **parameters** array Filled-in answers to the package's parameter questions **target\_url**string URL to redirect user to after assessment **status** enum Valid values: "OPEN" "IN\_PROGRESS" "COMPLETED" "FAILED" "REJECTED" **reference**string ATS-specific reference ID **application\_id**string ATS application ID **job\_id**string ATS job ID **company\_id**string ATS company ID (reference to AtsCompany) **candidate\_id**string ATS candidate ID **employee\_id**string ATS employee ID **profile\_name**string **profile\_first\_name**string **profile\_last\_name**string **profile\_resume\_url**string **profile\_ip\_address**string XXX.XXX.XXX.XXX **profile\_date\_of\_birth**string YYYY-MM-DD **profile\_addresses** array **profile\_gender** enum Valid values: "MALE" "FEMALE" "INTERSEX" "TRANS" "NON\_BINARY" **profile\_emails**string array **profile\_telephones**string array **profile\_national\_identifier**string **profile\_social\_media\_urls**string array **response\_completed\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_expires\_at**date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_issued\_at**date Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **response\_status** enum Valid values: "OPEN" "IN\_PROGRESS" "COMPLETED" "FAILED" "REJECTED" **response\_score**number Assessment score (e.g., 0-100) **response\_max\_score**number Maximum possible score **response\_url**string URL to view detailed results **response\_redirect\_url**string URL to redirect the user to complete assessment **response\_download\_urls**string array Report download URLs **response\_details** array **response\_source**string **response\_attributes** array Additional result attributes **raw**any ## Code Samples ### Node.js SDK ``` import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.assessment.updateAssessmentOrder({ connectionId, id, assessmentOrder: { }, fields: '', raw: '', }); ``` ### Node.js (axios) ``` const options = { method: 'PUT', url: 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, data: undefined, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ``` AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("PUT", "https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ``` import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("PUT", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ``` import requests url = "https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.put(url, headers=headers) ``` ### PHP ``` $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ``` require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ``` curl --request PUT \ --url 'https://api.unified.to/assessment/5de520f96e439b002043d8dc/order/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```