API documentation | API docs for agents | OpenAPI 3.1

notifications

ark.set_load_notification_settings

Creates or updates tracking notification settings for a visible load.

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

emailsarray<string>required

min items: 1; max items: 50

enabledbooleanrequired

notifyOnArrivalboolean

default: true

notifyOnDepartureboolean

default: true

notificationIntervalMinutesinteger

default: 120; min: 15; max: 1440

notesstring | null

max length: 5000

Example request

Shell

curl -X PUT 'https://arktms.com/api/v1/loads/<loadId>/notifications' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "emails": [
    "<emails>"
  ],
  "enabled": false
}'

Success response

Saved load notification settings

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadIdstringrequired

format: uuid

data.loadobjectrequired

data.settingsobjectrequired

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