Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

Bulk-update the monitoring status of multiple workflows

Transitions multiple monitoring workflows to the given workflowStatus in a single call. Use this endpoint for batch status changes; use PUT /monitoring-workflows/{workflowId}/status for a single workflow. Allowed workflowStatus values: IN_PROGRESS, OUTREACH_IN_PROGRESS, DATA_MISSING, NO_ACTION_REQUIRED, REVIEWED_BY_CERTIFYOS. The optional description field is a free-text note attached to the transition. Requires MONITORING_WORKFLOW_UPDATE. The tenant-id header is mandatory. Always returns HTTP 200, even when some workflows fail to transition — check the successfulWorkflowIds and failures arrays.

put/monitoring-workflows/bulk/status

Headers

tenant-idstring required

Tenant ID

Request body

workflowIdsstring[] required

List of monitoring workflow IDs to update

workflowStatusstring required

The new workflow status

descriptionstring required

Description for the timeline event

Example request

{
  "workflowIds": [
    "workflow-id-1",
    "workflow-id-2"
  ],
  "workflowStatus": "IN_PROGRESS",
  "description": "Monitoring workflow status changed to IN_PROGRESS"
}

Response

Bulk status update completed. totalCount/successCount/failureCount summarize the batch; successfulWorkflowIds lists updated workflow IDs; failures is an array of {workflowId, errorMessage} for the ones that failed.

totalCountinteger

Total number of workflows processed

successCountinteger

Number of successfully updated workflows

failureCountinteger

Number of failed updates

successfulWorkflowIdsstring[]

List of successfully updated workflow IDs