Update
curl --request PATCH \
--url https://{defaultHost}/v1/parcel_templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parcel_template": {
"name": "Medium Box"
}
}
'import requests
url = "https://{defaultHost}/v1/parcel_templates/{id}"
payload = { "parcel_template": { "name": "Medium Box" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({parcel_template: {name: 'Medium Box'}})
};
fetch('https://{defaultHost}/v1/parcel_templates/{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://{defaultHost}/v1/parcel_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'parcel_template' => [
'name' => 'Medium Box'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/parcel_templates/{id}"
payload := strings.NewReader("{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{defaultHost}/v1/parcel_templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/parcel_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "0ea6dd53-4f43-490a-8c4d-3b173bd01f94",
"object": "parcel_template",
"default": false,
"dimensions": {
"length": 10,
"width": 8,
"height": 6,
"unit": "in"
},
"name": "Medium Box",
"package_type": "box",
"weight": 5,
"weight_unit": "lb",
"created_at": 1786444782,
"updated_at": 1786444782
}Parcel Templates
Update
Updates a specific parcel template.
PATCH
/
v1
/
parcel_templates
/
{id}
Update
curl --request PATCH \
--url https://{defaultHost}/v1/parcel_templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"parcel_template": {
"name": "Medium Box"
}
}
'import requests
url = "https://{defaultHost}/v1/parcel_templates/{id}"
payload = { "parcel_template": { "name": "Medium Box" } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({parcel_template: {name: 'Medium Box'}})
};
fetch('https://{defaultHost}/v1/parcel_templates/{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://{defaultHost}/v1/parcel_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'parcel_template' => [
'name' => 'Medium Box'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/parcel_templates/{id}"
payload := strings.NewReader("{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://{defaultHost}/v1/parcel_templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/parcel_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"parcel_template\": {\n \"name\": \"Medium Box\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "0ea6dd53-4f43-490a-8c4d-3b173bd01f94",
"object": "parcel_template",
"default": false,
"dimensions": {
"length": 10,
"width": 8,
"height": 6,
"unit": "in"
},
"name": "Medium Box",
"package_type": "box",
"weight": 5,
"weight_unit": "lb",
"created_at": 1786444782,
"updated_at": 1786444782
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
Success
The UUID of the specific object.
A string describing the object type returned.
Whether or not this parcel template is the account's default.
A name for this parcel template.
The type of package – one of box, poly_mailer.
The physical dimensions of this parcel template.
Show child attributes
Show child attributes
The weight of this parcel template.
The weight unit for this parcel template – one of lb, oz, kg, g.
Time at which the object was created. Measured in seconds since the Unix epoch.
Time at which the object was last updated. Measured in seconds since the Unix epoch.
Was this page helpful?
⌘I