API documentation | API docs for agents | OpenAPI 3.1

{loadId}

ark.update_load_details

Updates a visible load revision, including customer, team, reps, reference fields, commodity, dimensions, currencies, customer-pay lines, and optional full stop replacement.

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. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

customerIdstring | null

format: uuid

teamIdstring

format: uuid

brokerIdstring | null

format: uuid

customerServiceRepIdstring | null

format: uuid

temperaturenumber | null

internalCommentsstring | null

max length: 5000

externalCommentsstring | null

max length: 5000

hotCommentsstring | null

max length: 5000

pickupNumberstring | null

max length: 100

purchaseOrderNumberstring | null

max length: 100

billOfLadingstring | null

max length: 100

productstring | null

max length: 200

valuenumber | null

descriptionstring | null

max length: 5000

sizestring | null

max length: 100

trailerstring | null

max length: 100

weightnumber | null

weightUnitstring

one of: lbs, kg

lengthnumber | null

widthnumber | null

heightnumber | null

numberOfPiecesinteger | null

min: 0

hazmatboolean

docHighboolean

stackableboolean

tsaboolean

teamDriverRequiredboolean

milesnumber | null

min: 0

maximumBuyAmountnumber | null

Maximum carrier buy amount for load-board and market-intelligence workflows.

min: 0

customerCurrencystring

one of: USD, CAD, MXN

carrierCurrencystring

one of: USD, CAD, MXN

customerPayarray<object>

Replacement customer-pay lines. Omit to leave customer pay unchanged.

max items: 100

stopsarray<object>

Replacement stop list. Omit to leave stops unchanged.

min items: 2; max items: 50

Example request

Shell

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

Success response

Updated load

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.idstringrequired

format: uuid

data.loadNumberstringrequired

data.statusstring | nullrequired

data.teamIdstring | nullrequired

format: uuid

data.customerobject | nullrequired

data.activeDispatchobject | nullrequired

data.pickupNumberstring | nullrequired

data.purchaseOrderNumberstring | nullrequired

data.billOfLadingstring | nullrequired

data.productstring | nullrequired

data.descriptionstring | nullrequired

data.createdAtstringrequired

format: date-time

data.modifiedAtstring | nullrequired

format: date-time

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