Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
ShipmentTemplates

Update a Shipment Template

Update a shipment template within the specified account.

put/public/v3/ShipmentTemplates/{shipmentTemplateId}

Path parameters

shipmentTemplateIdstring required

ID of the shipment template.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

namestring required

The unique name of the shipment template.

descriptionstring nullable

A description of the shipment template use case.

trackerStartDelay'ZeroMinutes' | 'ThirtyMinutes' | 'OneHour' | 'OneAndHalfHours' | 'TwoHours' | 'FourHours'

The period of time the tracker should wait before measuring or transmitting data after the start button is pressed. This is ONLY for Solo Pro Devices.

commoditiesinteger[] nullable

List of commodity ids to attach to the shipment template.

Response

The shipment template has been updated