latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Replace all supporting documents on a credentialing workflow

Replaces the entire supporting documents array on the credentialing workflow identified by workflowId with the provided list (full-replacement PUT semantics). Any document currently on the workflow that is not included in the request will be removed from the workflow record. Send an empty array ([]) to remove all supporting documents. To add a single new document without affecting existing ones, use POST /credentialing-workflows/{workflowId}/supporting-documents.

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

Path parameters

workflowIdstring required

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

createdBystring

The user who created the record

statestring

The state associated with the supporting document

expirationDatestring date

sourcestring

The source of the supporting document

artifactLinkIdstring

System-managed identifier linking this entry to its corresponding row attachment(s). Read-only — supplied values on incoming requests are ignored.

Example request

[
  {
    "fileUrl": "credentialing-workflows/cw_123/supporting-documents/certificate.pdf-1729961373476",
    "fileType": "Medical License",
    "originalFileName": "medical_license.pdf",
    "createdBy": "user@example.com",
    "state": "CA",
    "source": "Manual Upload",
    "artifactLinkId": "f3a1-9b2c-4d5e-6f7a"
  }
]

Response

Supporting documents updated successfully

object required