Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Replace all licenses for a facility

Replaces the complete set of license 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 license 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}/licenses

Path parameters

idstring required

Facility ID

Headers

tenant-idstring

Request body

idstring

Optional client-side id

licenseNumberstring

License number

statestring

US state code

licenseTypestring

License type

licenseStatusstring

License status

licenseSourcestring

Source

issueDatestring

Issue date (YYYY-MM-DD)

expirationDatestring required

Expiration date (YYYY-MM-DD)

reportDatestring required

Report date (YYYY-MM-DD)

flaggedDatestring

Flagged date (YYYY-MM-DD)

urlstring

Reference URL

licenseNumberVariationsstring

Alternate license numbers

typestring

Legacy type field when present on stored rows

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

[
  {
    "licenseNumber": "LIC-10001",
    "state": "TX",
    "licenseType": "Facility",
    "licenseStatus": "Active",
    "licenseSource": "Manual entry",
    "issueDate": "2020-01-01",
    "expirationDate": "2030-01-01",
    "reportDate": "2020-01-01",
    "action": "delete"
  }
]

Response

Licenses updated successfully