API documentation | API docs for agents | OpenAPI 3.1

restore

ark.restore_load

Restores an archived visible load.

Availability: Expanded preview
Scopes: loads:write
ARK permissions: canDeleteLoad
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. Reuse the same key only for exact retries of the same request.; min length: 1; max length: 200

Request body

mutationIdstring

min length: 8; max length: 200

appointmentDispositionstring

one of: keep, clear

Example request

Shell

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

Success response

Restored load

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

Errors

No operation-specific error responses.