API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/loads/{loadId}/tracking/update-params
ark.get_tracking_update_params
Returns the active tracking session ARK would update, its current provider settings, and which update fields the provider supports.
- Availability
- Expanded preview
- Scopes
loads:read- ARK permissions
canViewLoads- Team visibility
- Required and enforced
- Idempotency-Key
- Not required
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
loadIdpathstringrequired- format: uuid
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/loads/<loadId>/tracking/update-params' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Tracking update params
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.loadIdstringrequiredformat: uuid
data.loadobjectrequireddata.providerstringrequiredone of: macropoint, truckertools, internal
data.trackingIdstringrequireddata.sessionsarray<object>requireddata.currentParamsobjectrequireddata.supportedUpdateFieldsarray<string>requireddata.providerNotesarray<string>requiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found