API documentation | API docs for agents | OpenAPI 3.1

route-segments

ark.save_load_route_segments

Replaces stored route geometry segments for a visible load using precomputed section mileage, duration, and encoded polyline data.

Availability: Expanded preview
Scopes: loads:write
ARK permissions: canEditLoad
Team visibility: Required and enforced
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

loadIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations.; min length: 1; max length: 255

Request body

routeParamsHashstring | null

Stable hash of the route parameters. Required when sections are provided.

min length: 1

sectionsarray<object>

default: []; max items: 25

clearExistingboolean

default: false

Example request

Shell

curl -X PUT 'https://arktms.com/api/v1/loads/<loadId>/route-segments' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Saved load route segments

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadIdstringrequired

format: uuid

data.segmentCountintegerrequired

min: 0

data.clearedExistingbooleanrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found
HTTP 409: Idempotency conflict or in-progress retry