Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Bulk delete credentialing workflows asynchronously

Asynchronously deletes multiple credentialing workflows via a chunked Cloud Tasks fan-out. Deduplicates IDs, splits into chunks, enqueues chunk tasks, and returns 202 immediately with a jobId and accepted ID count — not per-ID delete outcomes. Each chunk later enqueues per-workflow cascade-delete tasks using the same cascade path as single delete. Queue rate and retries are server-owned.

post/credentialing-workflows/bulk-delete

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[] required

Credentialing workflow IDs to delete. Required and non-empty; deduplicated server-side.

Example request

{
  "workflowIds": [
    "a2b4f213-f56e-49b7-9ffe-070ff70f0539",
    "b3c5f324-f67e-49b8-0aff-181ff81f1640"
  ]
}

Response

Bulk delete accepted. The body reports the jobId and how many IDs were accepted.

jobIdstring required

Server-generated correlation ID for this asynchronous bulk-delete job

requestedCountinteger required

Number of (deduplicated) workflow IDs accepted from the request

acceptedCountinteger required

Number of IDs handed off for processing (i.e. carried by a successfully enqueued chunk task). IDs in a chunk that failed to enqueue are NOT deleted.

status'ACCEPTED' | 'PARTIALLY_ACCEPTED' | 'FAILED' required

Outcome of the synchronous chunk fan-out: ACCEPTED (all chunks enqueued), PARTIALLY_ACCEPTED (some chunks failed to enqueue), or FAILED (none enqueued)

messagestring required

Human-readable summary of the asynchronous request outcome

Example response

{
  "jobId": "5f1c2e8a-9b3d-4c7e-8a21-0f6d2b4c1e90",
  "requestedCount": 25,
  "acceptedCount": 25,
  "status": "ACCEPTED",
  "message": "Deletion started. Your request to delete 25 workflow(s) is being processed in the background."
}