Update shipment custom field

PATCH /api/v2/shipments/{shipment_id}/custom_fields/{api_slug}

cURL

cURL

curl --request PATCH \
  --url https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}

Updates a specific custom field on a shipment by its api_slug.

Path parameters

Parameter	Required	Description
shipment_id	Yes	The ID of the shipment
api_slug	Yes	The api_slug of the custom field definition

Request body

Parameter	Required	Description
value	Yes	The new value to set

Authorization

Requires update permission on the shipment.

Response

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