MCP documentation | MCP docs for agents
ark_create_pay_hold
ark.create_pay_hold
Create a pay hold or claim for a visible ARK load so billing can pause customer and carrier payment until the issue is resolved.
- Availability
- Expanded preview
- Scopes
loads:readbilling:write- ARK permissions
canViewLoadscanMakeAdjustmentsone of: canViewBillingone of: canViewPayHoldsReportone of: canEditLoadone of: canMakeAdjustments- Team visibility
- Required and enforced
- Approval policy
ask_before_write- ARK approval request
- Required before execution
- Idempotency
- Required for external execution
- Read-only
- No
- Destructive
- No
- External side effect
- No
- Rate limit
- OAuth MCP credential and organization budgets
Input
loadIdstringrequiredVisible ARK load ID that should be placed on pay hold.
format: uuid
valuenumber | nullOptional claim value. Required when isClaim is true.
max: 99999999.99
notesstringOperational notes explaining why the load is being held.
max length: 5000
isClaimbooleanSet true when the hold represents a claim amount.
default: false
Result
The tool returns the canonical ark.create_pay_hold operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.