Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace all accreditations on a facility workflow

Replaces the entire accreditations list for the specified facility credentialing workflow with the array provided in the request body. When to use: Use when you want to set the canonical accreditation state for a workflow. Supply the complete desired list — omitting an existing item removes it. To clear all accreditations, send an empty array []. Preconditions: The workflow must belong to the caller's tenant. Returns: 200 OK with the updated workflow section. Returns 404 if the workflow is not found, 400 if the request body is invalid.

put/facility-credentialing-workflows/{workflowId}/accreditations

Path parameters

workflowIdstring required

Headers

tenant-idstring required

Request body

idNumberstring

The accreditation ID number

accreditationBodystring required

The accreditation body

statusstring

The status of the accreditation

effectiveDatestring

The effective date of the accreditation

expirationDatestring

The expiration date of the accreditation

sourcestring required

The source of the accreditation

createdAtstring

The date the record was created

createdBystring

The user who created the record

updatedAtstring

The date the record was last updated

updatedBystring

The user who last updated the record

verifiedDatestring

The date the accreditation was verified

verifiedBystring

The user who verified the accreditation

Example request

[
  {
    "idNumber": "ACC123456",
    "accreditationBody": "Joint Commission",
    "status": "Active",
    "effectiveDate": "2024-01-01",
    "expirationDate": "2024-01-01",
    "source": "Accreditation Body",
    "createdAt": "2024-01-01",
    "createdBy": "user@example.com",
    "updatedAt": "2024-01-01",
    "updatedBy": "user@example.com",
    "attachments": [
      {
        "createdAt": "2024-01-15T10:30:00Z",
        "fileType": "License",
        "fileUrl": "gs://bucket/facility-credentialing-workflow/attachments/file.pdf",
        "originalFileName": "license.pdf",
        "state": "CA",
        "expirationDate": "2025-12-31",
        "source": "CAQH",
        "createdBy": "user@example.com",
        "updatedAt": "2024-02-15T14:20:00Z",
        "updatedBy": "admin@example.com"
      }
    ],
    "verifiedDate": "2024-01-01",
    "verifiedBy": "verifier@example.com"
  }
]

Response

Accreditations updated successfully