API documentation | API docs for agents | OpenAPI 3.1

POST /api/v1/loads/{loadId}/dispatches/{dispatchId}/notes

ark.add_dispatch_note

Adds a broker-visible note to an active visible dispatch for calls, exceptions, and follow-up context.

Availability

Core 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

dispatchIdpathstringrequired

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

Example request

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

Success response

Added dispatch note

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