API documentation | API docs for agents | OpenAPI 3.1

email

ark.send_tracking_link_email

Sends a customer-facing tracking link email for the active or selected tracking provider on a visible load.

Availability: Expanded preview
Scopes: loads:dispatch
ARK permissions: canAssignLoads
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

recipientEmailstringrequired

format: email; max length: 500

recipientNamestring

min length: 1; max length: 200

messagestring | null

max length: 5000

senderNamestring

min length: 1; max length: 200

providerstring

one of: macropoint, truckertools, internal

Example request

Shell

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

Success response

Sent tracking link email

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.loadIdstringrequired

format: uuid

data.loadobjectrequired

data.recipientobjectrequired

data.providerstringrequired

one of: macropoint, truckertools, internal

data.providerDisplayNamestringrequired

data.trackingUrlstringrequired

format: uri

data.emailSentbooleanrequired

data.messagestringrequired

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
HTTP 502: External provider or worker queue could not be reached