latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace all supporting documents on a facility workflow

Replaces the entire supporting documents array for the specified facility credentialing workflow with the provided list (replace-all / desired-state semantics). When to use: Supply the complete desired list of supporting documents. Documents not included in the request will be removed. To clear all supporting documents, send an empty array []. To append a new document without affecting others, use POST /facility-credentialing-workflows/{workflowId}/supporting-documents. Preconditions: The workflow must belong to the caller's tenant. Returns: 200 OK with the updated supporting documents. Returns 404 if the workflow is not found.

put/facility-credentialing-workflows/{workflowId}/supporting-documents

Path parameters

workflowIdstring required

Facility credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

fileUrlstring required

URL of the supporting document file

fileTypestring required

Type of the supporting document

originalFileNamestring required

Original name of the uploaded file

createdAtstring

Date when the document was created

createdBystring

The user who created the record

statestring

The state associated with the supporting document

expirationDatestring

The expiration date of the supporting document

sourcestring

The source of the supporting document

Example request

[
  {
    "fileUrl": "facility-credentialing-workflows/fcw_123/supporting-documents/certificate.pdf-1729961373476",
    "fileType": "Facility License",
    "originalFileName": "facility_license.pdf",
    "createdAt": "2024-01-01",
    "createdBy": "user@example.com",
    "state": "CA",
    "expirationDate": "2024-01-01",
    "source": "Manual Upload"
  }
]

Response

Supporting documents updated successfully

object required