563848e0ecc0
Bulk-delete records from one credentialing workflow section
Deletes multiple records from a single section in one action (CP-36357, CP-37276). The supported sections are enumerated on the sectionName parameter; any other section is rejected with 400. Each recordId uses the '{section}-{index}' format (e.g. 'practiceLocations-3') and its section must match the sectionName path parameter, so a request can never delete outside the section it targets. Deletion is a single read-modify-write and soft-deletes the records: each removed record is archived into deletedData with the supplied intent/reason/reasonText, exactly as the single-record delete does. Partial failures (malformed, wrong section, out-of-bounds recordIds) are reported per record and do not block the valid deletions. NOTE: recordIds are positional, so this request must not be retried automatically — a replay after a successful-but-unseen response would delete whatever records shifted into those indices. Re-fetch the section and rebuild recordIds before any retry.
Path parameters
Section to delete from. Supported sections: boardCertifications, cds, dea, educationTraining, hospitalAffiliations, licenses, licensureActions, malpracticeInsurance, npdbReports, practiceLocations, professionalIds, sanctions, specialties. Any other section is rejected with 400 — note that supportingDocuments has its own dedicated bulk-delete endpoint.
Credentialing workflow ID
Headers
Tenant ID
Request body
Example request
{
"recordIds": [
"practiceLocations-0",
"practiceLocations-3"
],
"deletion": {
"intent": "WORKFLOW_IRRELEVANCE",
"reason": "OUT_OF_CREDENTIALING_SCOPE",
"reasonText": "The practitioner is not in scope for this workflow"
}
}Response
At least one record was deleted; body reports the deleted and failed records
Example response
{
"section": "practiceLocations",
"deleted": [
"practiceLocations-0",
"practiceLocations-3"
],
"failed": [
{
"recordId": "practiceLocations-9",
"reason": "Record index 9 out of bounds for section 'practiceLocations' (size: 4)"
}
]
}