Sign in
CredentialingWorkflow

Delete a record from a named section of a credentialing workflow

Deletes the section record identified by recordId from the specified sectionName of the credentialing workflow identified by workflowId. The recordId format is {section}-{index} (e.g. dea-0, licenses-1). Works for all sections that support record-level CRUD operations. This operation is not idempotent — a second delete for the same recordId returns 404.

delete/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

intentstring

Deletion intent. Null is accepted when the soft-delete modal is disabled and intent is not collected from the user.

reasonstring

Deletion reason. Null is accepted when the soft-delete modal is disabled and reason is not collected from the user.

reasonTextstring

Free-text explanation; required when reason is OTHER. Max 2000 characters.

Example request

{
  "intent": "WORKFLOW_IRRELEVANCE",
  "reason": "OUT_OF_CREDENTIALING_SCOPE",
  "reasonText": "The practitioner is not in scope for this workflow"
}

Response

Record deleted successfully

object required

Changes