API documentation | API docs for agents | OpenAPI 3.1

retry

ark.retry_quickbooks_sync_job

Retries a visible failed QuickBooks sync job by resetting retryable items, requeueing the worker, and recording a lifecycle event.

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

jobIdpathstringrequired: 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

None.

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/integrations/quickbooks/sync-jobs/<jobId>/retry' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>"

Success response

Retried QuickBooks sync job

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.jobobjectrequired

data.previousStatusstringrequired

one of: queued, enqueue_failed, processing, retrying, succeeded, partial_failed, failed, stuck, canceled

data.resetItemCountintegerrequired

data.messageIdstring | nullrequired

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