Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace all certificates on a facility workflow

Replaces the entire certificates list for the specified facility credentialing workflow with the array provided in the request body. When to use: Supply the complete desired list — omitting an existing item removes it. To clear all certificates, 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}/certificates

Path parameters

workflowIdstring required

Headers

tenant-idstring required

Request body

certificateIdstring

The certificate ID

certificateTypestring required

The type of certificate

durationTypestring

The duration type

expirationDatestring

The expiration date of the certificate

issueDatestring

The issue date of the certificate

specialitystring

The specialty associated with the certificate

subspecialitystring

The subspecialty associated with the certificate

mocstring

Maintenance of Certification status

statusstring

The status of the certificate

occurrenceTypestring

The occurrence type

recordTypestring

The record type

numberstring required

The certificate number

sourcestring required

The source of the certificate

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 certificate was verified

verifiedBystring

The user who verified the certificate

Example request

[
  {
    "certificateId": "CERT123456",
    "certificateType": "ISO 9001",
    "durationType": "Annual",
    "expirationDate": "2024-01-01",
    "issueDate": "2024-01-01",
    "speciality": "Cardiology",
    "subspeciality": "Interventional",
    "moc": "Active",
    "status": "Active",
    "occurrenceType": "Initial",
    "recordType": "Primary",
    "number": "CERT-2024-001",
    "source": "Certification 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

Certificates updated successfully