API documentation | API docs for agents | OpenAPI 3.1
PATCH /api/v1/spot-quotes/{spotQuoteId}
ark.update_spot_quote
Updates customer, freight, reference, schedule, and stop details on a visible active spot quote.
- 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
spotQuoteIdpathstringrequired- format: uuid
Idempotency-Keyheaderstringrequired- Required for external write operations.
- min length: 1; max length: 255
Request body
customerIdstringformat: uuid
customerEmailstring | nullformat: email; max length: 254
currencystringone of: USD, CAD, MXN
referenceNumberstring | nullmax length: 100
loadClassificationstring | nullmax length: 100
sylectusLoadTypeinteger | nullvehicleTypestring | nullmax length: 100
piecesinteger | nullmin: 1
dimensionsLengthnumber | nulldimensionsWidthnumber | nulldimensionsHeightnumber | nulldimensionsUnitstringone of: inches, feet
weightnumber | nullweightUnitstringone of: lbs, kg
stackablebooleanhazmatbooleandockHighbooleanteamDriverRequiredbooleantsabooleannotesInternalstring | nullmax length: 5000
notesExternalstring | nullmax length: 5000
distanceMilesnumber | nullstopsarray<object>min items: 2; max items: 50
Example request
Shell
curl -X PATCH 'https://arktms.com/api/v1/spot-quotes/<spotQuoteId>' \
-H "Authorization: Bearer $ARK_API_TOKEN" \
-H "Idempotency-Key: <unique-key>" \
-H "Content-Type: application/json" \
-d '{}'Success response
Updated spot quote
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.spotQuoteIdstringrequiredformat: uuid
data.spotQuoteobjectrequireddata.resultobjectdata.sideEffectErrorstring | nullrequiredErrors
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