Update an Order
curl --request PATCH \
--url https://api.example.com/v1/orders/{id}/import requests
url = "https://api.example.com/v1/orders/{id}/"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/v1/orders/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/orders/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/orders/{id}/"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/orders/{id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyOrders
Update an Order
Modify an existing order when all employers are in pending or sent status
PATCH
/
v1
/
orders
/
{id}
/
Update an Order
curl --request PATCH \
--url https://api.example.com/v1/orders/{id}/import requests
url = "https://api.example.com/v1/orders/{id}/"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/v1/orders/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/orders/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/orders/{id}/"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/orders/{id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyEndpoint Overview
PATCHhttps://prod.transcrypts.com/v1/orders/{id}/
This endpoint modifies an existing order. Updates are only permitted when all employers maintain one of these statuses: pending or sent.
Authentication
The endpoint requires API credentials passed via headers:- ClientID (Header)
- AccessKey (Header)
Parameters
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Required. The order identifier to update |
Key Constraint
Update is only available if all employers are in one of the following statuses:
pending or sent. This means the order can only be modified while employers are in an early stage of the verification process.