Skip to main content
POST
/
case-refresh
/
bulk
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "response": {
    "totalRequested": 5,
    "totalUpdated": 4,
    "totalNoChange": 0,
    "totalFailed": 1,
    "refreshedAt": "2024-01-15T10:30:00.000Z",
    "results": [
      {
        "cnrNumber": "<string>",
        "refreshStatus": "<string>",
        "changesDetected": true,
        "changes": [
          {
            "field": "caseStatus",
            "oldValue": "<unknown>",
            "newValue": "<unknown>"
          }
        ],
        "error": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
cnrNumbers
string[]
required

Array of CNR numbers to refresh. Maximum 20.

Required array length: 1 - 20 elements
Minimum string length: 1
​
force
boolean

When true, bypasses the recency check for all cases in the batch.

​
returnOnlyChanged
boolean

When true, the results array includes only cases where changes were detected, omitting unchanged cases.

Response

Bulk refresh complete

​
success
boolean
required
Example:

true

​
response
object
required