v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility

Update licenses for a facility (OV)

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

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