Skip to main content
PATCH
Update a shipment custom field
Updates a specific custom field on a shipment by its api_slug.

Path parameters

Request body

Authorization

Requires update permission on the shipment.

Response

Returns 200 OK with the updated custom field resource on success.

Authorizations

Authorization
string
header
required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

shipment_id
string
required

Shipment ID

api_slug
string
required

Custom field api_slug

Body

application/json
data
object

Response

200 - application/json

OK

data
Custom field · object