Sign in
CredentialingWorkflow

Update a record in a named section of a credentialing workflow

Partially updates the section record identified by recordId within the specified sectionName of the credentialing workflow identified by workflowId. The recordId format is {section}-{index} (e.g. dea-0, licenses-1). The request body schema varies by section — refer to the schema definition for the target section.

patch/credentialing-workflows/{workflowId}/{sectionName}/{recordId}

Path parameters

recordIdstring required

Record identifier format: '{section}-{index}' (e.g., 'appVerifications-0')

sectionNamestring required

Section name. Available sections: appVerifications, boardCertifications, cds, dea, educationTraining, hospitalAffiliations, licenses, licensureActions, malpracticeInsurance, npdbReports, performanceIndicators, practiceLocations, professionalIds, sanctions, siteVisits, specialties, supportingDocuments

workflowIdstring required

Credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "createdBy": "user@example.com",
  "updatedBy": "admin@example.com",
  "attachments": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "fileType": "DEA Certificate",
      "fileUrl": "credentialing-workflow-attachments/workflow-123/dea/1729771200000_dea-certificate.pdf",
      "originalFileName": "dea-certificate.pdf",
      "expirationDate": "2025-12-31",
      "artifactLinkId": "f3a1-9b2c-4d5e-6f7a"
    }
  ],
  "verifiedBy": "John Smith",
  "verificationType": "Background Check",
  "explanation": "Completed background check successfully",
  "source": "Third Party Verification Service",
  "disclosureQuestions": [
    {
      "question": "Are you able to perform all the essential functions?",
      "answer": "Yes, I can perform all functions",
      "answerFlag": "false",
      "explanation": "Additional details if needed"
    }
  ]
}

Response

Record updated successfully

object required

Changes