Refresh a client's eFolder documents

Required scope: document-refreshes:write.

Asks Chronicle to check the client's SSA eFolder and download any new documents. It refreshes documents only; it does not update case status or renew download links. Send an empty JSON object as the body.

If a refresh is already in progress for the client, that refresh is returned instead of starting another. A client that cannot be refreshed through ERE returns 409 ere_ineligible. Poll Get a document refresh or subscribe to the v2.document_refresh.completed and v2.document_refresh.failed webhooks. OCR, extraction and packet generation happen separately.

Requires an Idempotency-Key. Retrying with the same key and body within 24 hours returns the original result without repeating the action. Counts toward the heavy-operation rate limit.

POST /api/v2/clients/{id}/document-refreshes
Bearer token scope document-refreshes:write

Path parameters

· 1
id string required

Client ID.

Headers

· 1
Idempotency-Key string · min length: 1· max length: 128 · pattern required

Unique key for this operation, 1 to 128 visible ASCII characters (for example a UUID). Reuse it only when retrying the same request.

Body

required application/json
value object

Responses