latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility

Replace a facility's supporting documents

Replaces the complete set of supporting documents for the specified facility — this is a full-array replace, not a per-item update-or-delete operation. There is no action field on the request items; every submitted item is written as-is, and any existing document not present in the submitted array is removed. To remove one document, resend the full array with that item omitted; to remove all documents, submit an empty array. The underlying stored file is never deleted from GCS by this call — only the metadata entry is removed from the facility's document list, so the file itself remains in storage. To attach a new document without affecting existing ones, use POST /facilities/{id}/supporting-documents instead, which appends rather than replaces.

put/facilities/{id}/supporting-documents

Path parameters

idstring required

Facility ID

Headers

tenant-idstring

Request body

fileUrlstring required

URL of the supporting document file

fileTypestring

Type of the supporting document

originalFileNamestring

Original name of the uploaded file

createdAtstring date
createdBystring

Email of the user who created the document

statestring

State associated with the document

expirationDatestring date
sourcestring

Source of the document

Example request

[
  {
    "fileUrl": "https://storage.example.com/documents/certificate.pdf",
    "fileType": "PDF",
    "originalFileName": "facility_license.pdf",
    "createdBy": "user@example.com",
    "state": "CA",
    "source": "manual"
  }
]

Response

Supporting documents updated successfully