latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Replace all insurances for a facility

Replaces the complete set of insurance records for the specified facility in the Operational View (the live, editable roster data). Records not present in the new list are removed — sending the same list twice produces the same result (idempotent). Use this to bulk-synchronize a facility's insurance data; this endpoint does not affect snapshots captured inside active credentialing workflow runs — those are managed separately through the credentialing workflow. Returns only a confirmation message, not the replaced records or their IDs.

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