Manage a Shipment Share Link

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Query Params
Headers
Responses

400

Unable to set share link on the shipment. See response message for details.

401

Unauthorized

500

Internal Server Error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json