---
updatedAt: 2026-05-28T15:05:48.000Z
agentTools:
  projectIndex: https://developers.tive.com/llms.txt
---

# Update a Shipment Template

Update a shipment template within the specified account.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Tive Public API",
    "description": "API to interact with Tive services, data and devices.<br/>All Rights Reserved 2026",
    "contact": {
      "name": "Tive Support",
      "email": "support@tive.com"
    },
    "version": "V3"
  },
  "servers": [
    {
      "url": "https://api.tive.com",
      "description": "production"
    }
  ],
  "paths": {
    "/public/v3/ShipmentTemplates/{shipmentTemplateId}": {
      "put": {
        "tags": [
          "ShipmentTemplates"
        ],
        "summary": "Update a Shipment Template",
        "description": "Update a shipment template within the specified account.",
        "parameters": [
          {
            "name": "shipmentTemplateId",
            "in": "path",
            "description": "ID of the shipment template.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "x-tive-account-id",
            "in": "header",
            "description": "ID of the account the request will be made in.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentTemplateRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentTemplateRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/ShipmentTemplateRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The shipment template has been updated"
          },
          "400": {
            "description": "Unable to update the shipment template.  See response message for details."
          },
          "401": {
            "description": "Unauthorized"
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AddressRequest": {
        "required": [
          "country",
          "locality",
          "postalCode",
          "state",
          "street"
        ],
        "type": "object",
        "properties": {
          "street": {
            "minLength": 1,
            "type": "string"
          },
          "sublocality": {
            "type": "string",
            "nullable": true
          },
          "locality": {
            "minLength": 1,
            "type": "string"
          },
          "state": {
            "minLength": 1,
            "type": "string"
          },
          "country": {
            "minLength": 1,
            "type": "string"
          },
          "postalCode": {
            "minLength": 1,
            "type": "string"
          }
        },
        "additionalProperties": false,
        "description": "The full address of the location."
      },
      "CoordinateRequest": {
        "required": [
          "latitude",
          "longitude"
        ],
        "type": "object",
        "properties": {
          "latitude": {
            "type": "number",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "Coordinates of the location."
      },
      "EndOfTripConfigurationRequest": {
        "type": "object",
        "properties": {
          "sendToCollaborators": {
            "type": "boolean",
            "description": "Should collaborators receive end of trip report."
          },
          "users": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of userIds for users that should receive the end of trip report.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShipmentLegTemplateRequest": {
        "required": [
          "mode"
        ],
        "type": "object",
        "properties": {
          "mode": {
            "minLength": 1,
            "type": "string",
            "description": "The mode of transportation. Values can be `Road`, `Ocean`, `Air`, or `Rail`."
          },
          "carrierId": {
            "type": "string",
            "description": "ID of the carrier responsible for transport of the leg.",
            "nullable": true
          },
          "fromLocationId": {
            "type": "integer",
            "description": "ID of a saved location to use as the leg origin. When provided, FromCoordinates and FromAddress must not be set. Either this ID or both FromCoordinates and FromAddress are required.",
            "format": "int32",
            "nullable": true
          },
          "fromCoordinates": {
            "$ref": "#/components/schemas/CoordinateRequest"
          },
          "fromAddress": {
            "$ref": "#/components/schemas/AddressRequest"
          },
          "toLocationId": {
            "type": "integer",
            "description": "ID of a saved location to use as the leg destination. When provided, ToCoordinates and ToAddress must not be set. Either this ID or both ToCoordinates and ToAddress are required.",
            "format": "int32",
            "nullable": true
          },
          "toCoordinates": {
            "$ref": "#/components/schemas/CoordinateRequest"
          },
          "toAddress": {
            "$ref": "#/components/schemas/AddressRequest"
          },
          "container": {
            "type": "string",
            "description": "The container ID used when the shipment leg mode is <emp>Ocean</emp>.",
            "nullable": true
          },
          "airWaybill": {
            "type": "string",
            "description": "The air waybill used when the shipment leg mode is <emp>Air</emp>.",
            "nullable": true
          },
          "legLabel": {
            "type": "string",
            "description": "The custom name of a shipment leg.",
            "nullable": true
          },
          "alertPresetIds": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int64"
            },
            "description": "A list of alert preset IDs that should trigger their respective alerts on a given shipment leg.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShipmentTemplateRequest": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "minLength": 1,
            "type": "string",
            "description": "The unique name of the shipment template."
          },
          "description": {
            "type": "string",
            "description": "A description of the shipment template use case.",
            "nullable": true
          },
          "customFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StringStringKeyValuePair"
            },
            "description": "Custom informational field that apply to your organization. Shipments allow for up to nine custom fields.",
            "nullable": true
          },
          "shipmentLegs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShipmentLegTemplateRequest"
            },
            "description": "For Shipments that make more than one stop, multiple Legs can be created for each stop that the shipment will make.",
            "nullable": true
          },
          "endOfTripConfiguration": {
            "$ref": "#/components/schemas/EndOfTripConfigurationRequest"
          },
          "trackerStartDelay": {
            "$ref": "#/components/schemas/TrackerStartDelay"
          },
          "commodities": {
            "type": "array",
            "items": {
              "type": "integer",
              "format": "int32"
            },
            "description": "List of commodity ids to attach to the shipment template.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StringStringKeyValuePair": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "nullable": true
          },
          "value": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "TrackerStartDelay": {
        "enum": [
          "ZeroMinutes",
          "ThirtyMinutes",
          "OneHour",
          "OneAndHalfHours",
          "TwoHours",
          "FourHours"
        ],
        "type": "string",
        "description": "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."
      }
    }
  }
}
```