latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Bulk-delete supporting-document records from a credentialing workflow

Deletes multiple supporting-document records in one action. Each recordId uses the '{section}-{index}' format (e.g. 'supportingDocuments-3'); section must be supportingDocuments. Deletion is a single read-modify-write and hard-deletes the records (no tombstone), matching single-record delete behaviour. Partial failures (malformed, wrong section, out-of-bounds, duplicate recordIds) are reported per record and do not block the valid deletions.

post/credentialing-workflows/{workflowId}/supporting-documents/bulk-delete

Path parameters

workflowIdstring required

Credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

recordIdsstring[] required

Record identifiers in '{section}-{index}' format; section must be supportingDocuments. At most 500 per request.

Example request

{
  "recordIds": [
    "supportingDocuments-0",
    "supportingDocuments-3"
  ]
}

Response

At least one record was deleted; body reports the deleted and failed records

deletedstring[] required

Record identifiers that were successfully deleted.

Example response

{
  "deleted": [
    "supportingDocuments-0",
    "supportingDocuments-3"
  ],
  "failed": [
    {
      "recordId": "supportingDocuments-9",
      "reason": "Record index 9 out of bounds for section 'supportingDocuments' (size: 4)"
    }
  ]
}