Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

MonitoringWorkflow

Transition a monitoring workflow to a new status

Updates the monitoringStatus of a single workflow to the given target status. Use this endpoint for individual status transitions; use PUT /monitoring-workflows/bulk/status for batch transitions. 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.

put/monitoring-workflows/{workflowId}/status

Path parameters

workflowIdstring required

ID of the monitoring workflow

Headers

tenant-idstring required

Tenant ID

Request body

workflowStatusstring required

The new workflow status

descriptionstring required

Description for the timeline event

Example request

{
  "workflowStatus": "IN_PROGRESS",
  "description": "Monitoring workflow status changed to IN_PROGRESS"
}

Response

The updated monitoring workflow.

idstring
tenantPractitionerIdstring
tenantIdstring
certifyPractitionerIdstring
createdAtstring date
createdBystring
updatedAtstring date
updatedBystring
otherWorkflowsobject