API Docs / Operations / Task - Workflows / Execute Workflow Step

Execute Workflow Step

POST /tenants/{tenant}/tasks/{taskCode}/workflow/groups/{groupNumber}/steps/{stepNumber}/execute

Queues a typed workflow step (e.g., SendEmail) for async execution.

Validation:

  • Step must exist and belong to the tenant
  • StepType must not be Standard (standard steps are manual checklist items)
  • Status must be NotStarted (prevents re-execution of already sent emails)
  • CanStart must be true (all dependency steps completed)

On success, a WorkflowStepActionMessage is queued to the workflow-step-action queue
for processing by the function app. Returns 202 Accepted immediately.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

groupNumber* path integer (int32)
stepNumber* path integer (int32)
taskCode* path string

Responses

202 Accepted
401 Unauthorized - Invalid or missing API key

Try it