---
title: "Updates a shipment plan details"
method: PATCH
path: "/shipments/v4/plans/{shipmentPlanId}"
tags: ["Shipments"]
---

# Updates a shipment plan details

`PATCH /shipments/v4/plans/{shipmentPlanId}`

Updates details of a shipment plan identified by the `shipmentPlanId`.
This is a partial update, meaning that only the provided
fields will be updated. If `ruleIds` field is specified, it will replace
the existing rules currently associated with the shipment plan.

***Note***:
`segments` cannot be edited through this API. Changing the order of the segments in a plan
would cause shipments created from earlier versions of the plan diverge from a shipment
instantiated from the new plan with different segment structure. Individual segments can
still be updated via the `shipments/v4/plans/{shipmentPlanId}/{segmentPlanId}` endpoint.

## Request body

- object — Body for updating a shipment plan
  - `autoStart` boolean — A boolean parameter defining whether the shipment starts upon exiting the first origin location.
  - `description` string — Description of the shipment
  - `name` string — Name of the shipment
  - `ruleIds` string[] — Array of `ruleId`s to associate with the shipment
  - `subShipment` boolean — Flag telling if shipment is a subShipment.

## Response `204`

Successful (no content)

The shipment plan information was updated

## Other responses

- `400` — Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.
- `401` — Unauthorized The request did not provide correct authentication details
- `403` — Forbidden The account does not have the correct privileges
- `404` — Not Found The specified resource was not found

---

[API](https://skmtc.net/here/apis/tracking.md) · [All operations](https://skmtc.net/here/apis/tracking/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/here/tracking/versions/efa162f7023c/schema)