API documentation | API docs for agents | OpenAPI 3.1

send

ark.retry_billing_email_delivery

Retry Billing Email Delivery through the authoritative Billing application boundary.

Availability: Expanded preview
Scopes: loads:readbilling:write
ARK permissions: canViewLoadscanViewBillingcanMakeAdjustments
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

Idempotency-Keyheaderstringrequired: Stable key for safe replay of this exact operation input.; min length: 8; max length: 200

Request body

deliveryIdstringrequired

format: uuid

attemptVersionintegerrequired

max: 9007199254740991

recipientstringrequired

format: email; max length: 320

saveRecipientAfterDeliveryboolean

default: false

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/delivery-retries/send' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "deliveryId": "<deliveryId>",
  "attemptVersion": 1,
  "recipient": "<recipient>"
}'

Success response

Operation result.

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.retryobjectrequired

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