KintsugiKintsugi

Pause filings in bulk

POST/filings/bulk/pause

Pause several filings in one organization. Requires an ADMIN or OWNER credential; send an Organization-Id, Connection-Id or Entity-Id selector to say which organization they belong to. pauseIntent says why (review needs pausedUntilDate). Returns 200 with a per-filing successful/failed breakdown even when some filings cannot be paused; large batches are enqueued and reported with queued true.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

filingIdsstring[]Required

Ids of the filings to pause. Duplicates are ignored.

pauseIntentPublicPauseIntentEnumRequired

Why the filings are being paused.

Available options:reviewassistanceskip
pausedUntilDatestring

Date a review pause auto-resumes, as YYYY-MM-DD. Required for review; ignored for assistance and skip.

pauseReasonstring

Optional customer-supplied reason for the pause.

requestIdstring

Client-minted id for this confirm attempt, stored on the audit row.

Response

successfulstring[]Required

Filing ids acted on, or accepted for a worker when queued.

failedBulkFilingFailure[]Required

Requested filings that were not acted on, each with a reason.

queuedboolean

Whether the batch was enqueued for a worker rather than applied inline.

jobIdstring

Reserved for a pollable job handle; null until a job surface exists.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
POST /filings/bulk/pause
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"filingIds": [
"flng_1",
"flng_2"
],
"pauseIntent": "review",
"pausedUntilDate": "2026-07-21",
"pauseReason": "Customer request",
"requestId": "req_2mNpQr7Ls8f3k"
}
Response
{
"successful": [
"successful"
],
"failed": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"reason": "Customer request"
}
],
"queued": false,
"jobId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10"
}
Pause filings in bulk (2026-07-21) | Kintsugi API Reference