const options = {
method: "POST",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "COMPLETED",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": "2026-09-10T18:00:00.000Z",
"cancelledAt": null
}
}
Workflow Runs
Complete Workflow Run
Finish a workflow run early
POST
/
api
/
v1
/
workflow-runs
/
:workflowRunId
/
complete
const options = {
method: "POST",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "COMPLETED",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": "2026-09-10T18:00:00.000Z",
"cancelledAt": null
}
}
Mark a workflow run complete before the agent has finished conducting it. Outreach to the lead stops, queued messages are cancelled, and whatever the workflow had left to do is skipped. Completing is final.
If the workflow is configured to mark the lead completed, the lead is completed too and a
This endpoint takes no body.
lead.completed webhook fires after workflow_run.completed.
A workflow run also completes on its own, without this call, once the workflow has nothing left to do.
Completing a workflow run that is already COMPLETED succeeds and changes nothing.
Authentication
Requires thex-api-key header with a valid workspace API key.
Path Parameters
string
required
The workflow run to complete.
Response
boolean
Whether the request succeeded.
object
The workflow run in its new state. See
Get Workflow Run for the
full shape.
Errors
error
No workflow run with this id exists in your workspace.
error
The workflow run is already
CANCELLED, or this workflow’s runs cannot be
completed manually. The error message says which.const options = {
method: "POST",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("POST", url, headers=headers)
print(response.json())
curl --request POST \
--url https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9/complete \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"workflowRun": {
"id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "COMPLETED",
"createdAt": "2026-09-10T17:42:03.000Z",
"completedAt": "2026-09-10T18:00:00.000Z",
"cancelledAt": null
}
}