curl --request PATCH \
--url https://flowra.dev/api/v1/workflow/manager/activeStatus/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"activeStatus": true
}
'import requests
url = "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}"
payload = { "activeStatus": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({activeStatus: true})
};
fetch('https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'activeStatus' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}"
payload := strings.NewReader("{\n \"activeStatus\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activeStatus\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activeStatus\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "",
"name": "",
"description": "",
"projectId": "",
"agent": {
"prompt": "",
"modelSettings": {},
"capabilities": {},
"behavior": {},
"identity": {},
"skillIds": [
""
],
"subAgentIds": [
""
],
"knowledgeCollectionIds": [
""
],
"databaseCollectionIds": [
""
],
"databaseAccessPolicies": {},
"starterPrompts": [
""
],
"avatarUrl": "",
"tools": {
"mode": "NORMAL",
"discoveryWhitelist": true,
"pinnedSlugs": [
""
],
"externalMcpConfigs": [
""
],
"connectionCallbackUrl": "",
"visitorOwnerConnections": {
"enabled": true,
"toolkits": []
}
},
"inputSchema": {},
"outputSchema": {}
},
"graph": {
"nodes": [
{
"id": "",
"type": "action",
"toolSlug": "",
"inputMapping": {},
"code": "",
"agent": {},
"outputSchema": {}
}
],
"edges": [
{
"from": "",
"to": "",
"condition": ""
}
],
"inputSchema": {},
"outputSchema": {}
},
"provenance": {
"createdByAgent": true,
"productCreationDepth": 0,
"createdFromWorkflowId": "",
"hideFromAgentPicker": true,
"marketplaceClone": {
"sourceWorkflowId": "",
"clonedAt": "",
"skillIdMap": {},
"knowledgeIdMap": {},
"databaseIdMap": {},
"subAgentIdMap": {},
"avatarFileIdMap": {},
"setupState": {
"answers": {},
"completedStepIds": [
""
]
}
}
},
"triggers": [
{
"kind": "manual",
"expression": "",
"timezone": "",
"toolSlug": "",
"triggerToolInput": {},
"triggerId": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"workflowType": "static",
"isActive": true,
"lifecycle": "draft",
"isPublic": true,
"version": "",
"clonedFromWorkflowId": "",
"clonedFromVersion": "",
"executionCount": 0,
"successfulExecutionCount": 0,
"failedExecutionCount": 0,
"lastExecutedAt": "",
"connections": [
{
"id": "",
"connectionId": "",
"toolkitSlug": "",
"displayName": "",
"label": "",
"createdAt": "",
"updatedAt": ""
}
],
"tools": [
{
"toolSlug": "",
"toolName": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"subAgents": [
""
],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sourceVersionLatest": "1.0.2",
"toolkitAuthConfigs": [
{
"toolkitSlug": "",
"authConfigId": "",
"name": "",
"authScheme": "",
"status": ""
}
],
"toolkitConnections": [
{
"toolkitSlug": "",
"connectedAccountId": "",
"displayName": "",
"label": "",
"status": "",
"authConfigId": ""
}
],
"marketplaceCategory": "",
"marketplaceAudience": "",
"marketplaceTagline": "",
"marketplaceSetupGuide": "",
"marketplaceSetupSpec": {},
"marketplaceSetupSkillId": "",
"marketplaceSetupSkillSlug": "",
"marketplaceHighlights": [
""
],
"marketplaceIsListed": true,
"marketplaceCapabilities": {
"hasSkills": true,
"skillCount": 0,
"hasKnowledge": true,
"hasDatabase": true,
"hasCron": true,
"requiresAuth": true,
"toolkitCount": 0,
"subAgentCount": 0,
"toolCount": 0
}
}
}Update workflow status
Turn a workflow on (active) or off (inactive). Only lifecycle=ready workflows can be activated. Inactive workflows are not auto-fired by cron/webhooks; manual EXECUTE may still run them for testing.
curl --request PATCH \
--url https://flowra.dev/api/v1/workflow/manager/activeStatus/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"activeStatus": true
}
'import requests
url = "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}"
payload = { "activeStatus": True }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({activeStatus: true})
};
fetch('https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'activeStatus' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}"
payload := strings.NewReader("{\n \"activeStatus\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activeStatus\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/workflow/manager/activeStatus/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activeStatus\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Operation completed successfully",
"data": {
"id": "",
"name": "",
"description": "",
"projectId": "",
"agent": {
"prompt": "",
"modelSettings": {},
"capabilities": {},
"behavior": {},
"identity": {},
"skillIds": [
""
],
"subAgentIds": [
""
],
"knowledgeCollectionIds": [
""
],
"databaseCollectionIds": [
""
],
"databaseAccessPolicies": {},
"starterPrompts": [
""
],
"avatarUrl": "",
"tools": {
"mode": "NORMAL",
"discoveryWhitelist": true,
"pinnedSlugs": [
""
],
"externalMcpConfigs": [
""
],
"connectionCallbackUrl": "",
"visitorOwnerConnections": {
"enabled": true,
"toolkits": []
}
},
"inputSchema": {},
"outputSchema": {}
},
"graph": {
"nodes": [
{
"id": "",
"type": "action",
"toolSlug": "",
"inputMapping": {},
"code": "",
"agent": {},
"outputSchema": {}
}
],
"edges": [
{
"from": "",
"to": "",
"condition": ""
}
],
"inputSchema": {},
"outputSchema": {}
},
"provenance": {
"createdByAgent": true,
"productCreationDepth": 0,
"createdFromWorkflowId": "",
"hideFromAgentPicker": true,
"marketplaceClone": {
"sourceWorkflowId": "",
"clonedAt": "",
"skillIdMap": {},
"knowledgeIdMap": {},
"databaseIdMap": {},
"subAgentIdMap": {},
"avatarFileIdMap": {},
"setupState": {
"answers": {},
"completedStepIds": [
""
]
}
}
},
"triggers": [
{
"kind": "manual",
"expression": "",
"timezone": "",
"toolSlug": "",
"triggerToolInput": {},
"triggerId": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"workflowType": "static",
"isActive": true,
"lifecycle": "draft",
"isPublic": true,
"version": "",
"clonedFromWorkflowId": "",
"clonedFromVersion": "",
"executionCount": 0,
"successfulExecutionCount": 0,
"failedExecutionCount": 0,
"lastExecutedAt": "",
"connections": [
{
"id": "",
"connectionId": "",
"toolkitSlug": "",
"displayName": "",
"label": "",
"createdAt": "",
"updatedAt": ""
}
],
"tools": [
{
"toolSlug": "",
"toolName": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"subAgents": [
""
],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sourceVersionLatest": "1.0.2",
"toolkitAuthConfigs": [
{
"toolkitSlug": "",
"authConfigId": "",
"name": "",
"authScheme": "",
"status": ""
}
],
"toolkitConnections": [
{
"toolkitSlug": "",
"connectedAccountId": "",
"displayName": "",
"label": "",
"status": "",
"authConfigId": ""
}
],
"marketplaceCategory": "",
"marketplaceAudience": "",
"marketplaceTagline": "",
"marketplaceSetupGuide": "",
"marketplaceSetupSpec": {},
"marketplaceSetupSkillId": "",
"marketplaceSetupSkillSlug": "",
"marketplaceHighlights": [
""
],
"marketplaceIsListed": true,
"marketplaceCapabilities": {
"hasSkills": true,
"skillCount": 0,
"hasKnowledge": true,
"hasDatabase": true,
"hasCron": true,
"requiresAuth": true,
"toolkitCount": 0,
"subAgentCount": 0,
"toolCount": 0
}
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Headers
External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.
Path Parameters
Workflow (agent) ID
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Body
True to activate the workflow (requires lifecycle=ready), false to deactivate it.
true
Response
Workflow status updated successfully
Success status
true
Success message
"Operation completed successfully"
Show child attributes
Show child attributes
{
"id": "",
"name": "",
"description": "",
"projectId": "",
"agent": {
"prompt": "",
"modelSettings": {},
"capabilities": {},
"behavior": {},
"identity": {},
"skillIds": [""],
"subAgentIds": [""],
"knowledgeCollectionIds": [""],
"databaseCollectionIds": [""],
"databaseAccessPolicies": {},
"starterPrompts": [""],
"avatarUrl": "",
"tools": {
"mode": "NORMAL",
"discoveryWhitelist": true,
"pinnedSlugs": [""],
"externalMcpConfigs": [""],
"connectionCallbackUrl": "",
"visitorOwnerConnections": { "enabled": true, "toolkits": [] }
},
"inputSchema": {},
"outputSchema": {}
},
"graph": {
"nodes": [
{
"id": "",
"type": "action",
"toolSlug": "",
"inputMapping": {},
"code": "",
"agent": {},
"outputSchema": {}
}
],
"edges": [{ "from": "", "to": "", "condition": "" }],
"inputSchema": {},
"outputSchema": {}
},
"provenance": {
"createdByAgent": true,
"productCreationDepth": 0,
"createdFromWorkflowId": "",
"hideFromAgentPicker": true,
"marketplaceClone": {
"sourceWorkflowId": "",
"clonedAt": "",
"skillIdMap": {},
"knowledgeIdMap": {},
"databaseIdMap": {},
"subAgentIdMap": {},
"avatarFileIdMap": {},
"setupState": { "answers": {}, "completedStepIds": [""] }
}
},
"triggers": [
{
"kind": "manual",
"expression": "",
"timezone": "",
"toolSlug": "",
"triggerToolInput": {},
"triggerId": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"workflowType": "static",
"isActive": true,
"lifecycle": "draft",
"isPublic": true,
"version": "",
"clonedFromWorkflowId": "",
"clonedFromVersion": "",
"executionCount": 0,
"successfulExecutionCount": 0,
"failedExecutionCount": 0,
"lastExecutedAt": "",
"connections": [
{
"id": "",
"connectionId": "",
"toolkitSlug": "",
"displayName": "",
"label": "",
"createdAt": "",
"updatedAt": ""
}
],
"tools": [
{
"toolSlug": "",
"toolName": "",
"toolkitName": "",
"toolkitLogo": ""
}
],
"subAgents": [""],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sourceVersionLatest": "1.0.2",
"toolkitAuthConfigs": [
{
"toolkitSlug": "",
"authConfigId": "",
"name": "",
"authScheme": "",
"status": ""
}
],
"toolkitConnections": [
{
"toolkitSlug": "",
"connectedAccountId": "",
"displayName": "",
"label": "",
"status": "",
"authConfigId": ""
}
],
"marketplaceCategory": "",
"marketplaceAudience": "",
"marketplaceTagline": "",
"marketplaceSetupGuide": "",
"marketplaceSetupSpec": {},
"marketplaceSetupSkillId": "",
"marketplaceSetupSkillSlug": "",
"marketplaceHighlights": [""],
"marketplaceIsListed": true,
"marketplaceCapabilities": {
"hasSkills": true,
"skillCount": 0,
"hasKnowledge": true,
"hasDatabase": true,
"hasCron": true,
"requiresAuth": true,
"toolkitCount": 0,
"subAgentCount": 0,
"toolCount": 0
}
}
Was this page helpful?