API documentation | API docs for agents | OpenAPI 3.1

bulk-resolve

ark.bulk_resolve_pay_holds

Resolves multiple active visible pay holds or claims in one batch, returning per-hold outcomes for report cleanup workflows.

Availability: Expanded preview
Scopes: loads:readbilling:write
ARK permissions: canViewLoadscanMakeAdjustmentsone of: canViewBillingone of: canViewPayHoldsReportone of: canEditLoadone of: canMakeAdjustments
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: 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

payHoldIdsarray<string>required

Active visible pay hold IDs to resolve in one batch.

min items: 1; max items: 100

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/pay-holds/bulk-resolve' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "payHoldIds": [
    "<payHoldIds>"
  ]
}'

Success response

Bulk pay hold resolution outcomes

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.resultsarray<object>required

data.successCountintegerrequired

min: 0

data.errorCountintegerrequired

min: 0

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 422: Invalid request