API documentation | API docs for agents | OpenAPI 3.1

settings

ark.update_integration_settings

Updates organization-level ARK Tracking, DAT, Sylectus, MacroPoint, TruckerTools, MyCarrierPortal, RMIS, or Highway settings and credentials.

Availability: Expanded preview
Scopes: admin:write
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

providerpathstringrequired: Integration provider.; one of: ark_tracking, dat, highway, macropoint, mycarrierportal, rmis, sylectus, truckertools
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

providerstringrequired

one of: ark_tracking, dat, highway, macropoint, mycarrierportal, rmis, sylectus, truckertools

enabledboolean

clientIdstring

max length: 200

clientSecretstring

max length: 2000

apiKeystring

max length: 2000

configobject

<key>any

Example request

Shell

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

Success response

Updated integration settings

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.providerstringrequired

one of: ark_tracking, dat, highway, macropoint, mycarrierportal, rmis, sylectus, truckertools

data.activebooleanrequired

data.configuredbooleanrequired

data.configobjectrequired

data.credentialsobjectrequired

data.metadataobjectrequired

data.updatedFieldsarray<string>required

data.credentialFieldsChangedarray<string>required

data.messagestringrequired

data.validationany

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 409: Idempotency conflict or in-progress retry
HTTP 503: External provider or worker queue could not be reached