API documentation | API docs for agents | OpenAPI 3.1

send

ark.send_spot_quote_invitations

Creates carrier invitation records for a visible spot quote and sends the requested email or in-app notifications.

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

spotQuoteIdpathstringrequired: format: uuid
Idempotency-Keyheaderstringrequired: Required for external write operations.; min length: 1; max length: 255

Request body

invitationsarray<object>required

min items: 1; max items: 100

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/spot-quotes/<spotQuoteId>/invitations/send' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "invitations": [
    {
      "carrierId": "<carrierId>",
      "channel": "in_app",
      "message": "<message>"
    }
  ]
}'

Success response

Invitation send result

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.spotQuoteIdstringrequired

format: uuid

data.totalInvitationsintegerrequired

data.notificationsSentintegerrequired

data.invitationsarray<object>required

data.notificationResultsarray<object>required

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