---
title: "Manage a Shipment Share Link"
method: PATCH
path: "/public/v3/Shipments/{shipmentId}/share-links"
tags: ["Shipments"]
---

# Manage a Shipment Share Link

`PATCH /public/v3/Shipments/{shipmentId}/share-links`

Creates, updates, or toggles a shareable link for a shipment.

**Behaviors based on parameters provided:**
- `enabled` + `accessLevel` — upserts the link for that access level with the given enabled state.
- `enabled=true` only — enables all existing links created by the calling user.
- `enabled=false` only — disables **all** shared links on the shipment, including links created by other users.

`accessLevel` values:
  - `LocationOnly` — viewers can see shipment location only
  - `ConditionOnly` — viewers can see sensor/condition data only
  - `LocationAndCondition` — viewers can see both location and sensor data

## Path parameters

- `shipmentId` string, required

## Query parameters

- `enabled` boolean, required
- `accessLevel` 'LocationOnly' | 'ConditionOnly' | 'LocationAndCondition' — The access level of the shared link. Valid values are `LocationOnly`, `ConditionOnly`, `LocationAndCondition`.

## Headers

- `x-tive-account-id` integer, required

## Response `200`

The shipment share link settings including the enabled state, access level, and shareable link.

- ShipmentShareResponse
  - `enabled` boolean — Whether this share link is enabled. Each access level has its own share link with an independent enabled state.
  - `accessLevel` 'LocationOnly' | 'ConditionOnly' | 'LocationAndCondition' — The access level of the shared link. Valid values are `LocationOnly`, `ConditionOnly`, `LocationAndCondition`.
  - `sharedLink` string, nullable — The shareable link for this shipment.

## Other responses

- `400` — Unable to set share link on the shipment. See response message for details.
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/versions/9a8d869e3cdc/schema)