Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility

Update insurances for a facility (OV)

Replaces all insurances for the given facility in the Operational View. Does not affect active credentialing workflow snapshots.

put/facilities/{id}/insurances

Path parameters

idstring required

Facility ID

Headers

tenant-idstring

Request body

idstring

Optional client-side id

policyNumberstring

Policy number (Number field in UI)

typestring

Insurance type

statusstring

Insurance status

effectiveDatestring

Effective date (YYYY-MM-DD)

expirationDatestring

Expiration date (YYYY-MM-DD)

occurrenceCoverageAmountstring

Occurrence coverage amount, numeric when present

aggregateCoverageAmountstring

Aggregate coverage amount, numeric when present

unlimitedCoverageboolean

Unlimited coverage flag

carrierNamestring

Carrier name

sourcestring

Source field

actionstring

Set to delete for soft-delete

deletedAtstring

Soft-delete timestamp

deletedBystring

Soft-delete actor

createdAtstring

Created timestamp

createdBystring

Created by

updatedAtstring

Updated timestamp

updatedBystring

Updated by

verifiedDatestring

Verified date

verifiedBystring

Verified by

Example request

[
  {
    "policyNumber": "POL-12345",
    "type": "General Liability",
    "status": "Active",
    "effectiveDate": "2025-01-01",
    "expirationDate": "2026-01-01",
    "occurrenceCoverageAmount": "1000000",
    "aggregateCoverageAmount": "2000000",
    "carrierName": "ABC Insurance",
    "source": "Manual entry",
    "action": "delete"
  }
]

Response

Insurances updated successfully