API documentation | API docs for agents | OpenAPI 3.1

{stopId}

ark.update_load_stop

Updates scheduled stop times, scheduling type, reference number, pieces, weight, or comment for a visible load stop. Actual arrival and departure event recording is intentionally handled by a separate workflow action.

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
stopIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

arrivalTimestring | null

format: date-time

arrivalTime2string | null

format: date-time

schedulingTypestring | null

one of: fcfs, appointment, null

referenceNumstring | null

max length: 100

piecesinteger | null

min: 0

weightnumber | null

min: 0

commentstring | null

max length: 5000

Example request

Shell

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

Success response

Updated load stop

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadIdstringrequired

format: uuid

data.stopobjectrequired

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