Update a workflow
curl --request PATCH \
--url https://api.modulex.dev/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-ID: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"category": "<string>",
"status": "<string>",
"visibility": "<string>",
"tags": [
"<string>"
],
"version": "<string>",
"workflow_schema": {},
"input": {},
"config": {}
}
'import requests
url = "https://api.modulex.dev/workflows/{workflow_id}"
payload = {
"name": "<string>",
"description": "<string>",
"category": "<string>",
"status": "<string>",
"visibility": "<string>",
"tags": ["<string>"],
"version": "<string>",
"workflow_schema": {},
"input": {},
"config": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Organization-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Organization-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
category: '<string>',
status: '<string>',
visibility: '<string>',
tags: ['<string>'],
version: '<string>',
workflow_schema: {},
input: {},
config: {}
})
};
fetch('https://api.modulex.dev/workflows/{workflow_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://api.modulex.dev/workflows/{workflow_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([
'name' => '<string>',
'description' => '<string>',
'category' => '<string>',
'status' => '<string>',
'visibility' => '<string>',
'tags' => [
'<string>'
],
'version' => '<string>',
'workflow_schema' => [
],
'input' => [
],
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-ID: <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://api.modulex.dev/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Organization-ID", "<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://api.modulex.dev/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.header("X-Organization-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.modulex.dev/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Organization-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"version": "<string>",
"tags": [
"<string>"
],
"category": "<string>",
"status": "draft",
"visibility": "organization",
"workflow_schema": {},
"input": {},
"config": {},
"edit_version": 123,
"last_edited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_edited_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Endpoints
Update a workflow
Update an existing workflow. All fields are optional — only provided fields are updated. Requires the organization admin or owner role. (Backend method is currently PUT; see openQuestions.)
PATCH
/
workflows
/
{workflow_id}
Update a workflow
curl --request PATCH \
--url https://api.modulex.dev/workflows/{workflow_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Organization-ID: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"category": "<string>",
"status": "<string>",
"visibility": "<string>",
"tags": [
"<string>"
],
"version": "<string>",
"workflow_schema": {},
"input": {},
"config": {}
}
'import requests
url = "https://api.modulex.dev/workflows/{workflow_id}"
payload = {
"name": "<string>",
"description": "<string>",
"category": "<string>",
"status": "<string>",
"visibility": "<string>",
"tags": ["<string>"],
"version": "<string>",
"workflow_schema": {},
"input": {},
"config": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Organization-ID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Organization-ID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
description: '<string>',
category: '<string>',
status: '<string>',
visibility: '<string>',
tags: ['<string>'],
version: '<string>',
workflow_schema: {},
input: {},
config: {}
})
};
fetch('https://api.modulex.dev/workflows/{workflow_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://api.modulex.dev/workflows/{workflow_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([
'name' => '<string>',
'description' => '<string>',
'category' => '<string>',
'status' => '<string>',
'visibility' => '<string>',
'tags' => [
'<string>'
],
'version' => '<string>',
'workflow_schema' => [
],
'input' => [
],
'config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Organization-ID: <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://api.modulex.dev/workflows/{workflow_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Organization-ID", "<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://api.modulex.dev/workflows/{workflow_id}")
.header("Authorization", "Bearer <token>")
.header("X-Organization-ID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.modulex.dev/workflows/{workflow_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Organization-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"category\": \"<string>\",\n \"status\": \"<string>\",\n \"visibility\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"workflow_schema\": {},\n \"input\": {},\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"version": "<string>",
"tags": [
"<string>"
],
"category": "<string>",
"status": "draft",
"visibility": "organization",
"workflow_schema": {},
"input": {},
"config": {},
"edit_version": 123,
"last_edited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"last_edited_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
User API key: Authorization: Bearer mx_live_*. The X-API-KEY: mx_live_* header is also accepted.
Required organization context for org-scoped endpoints.
Path Parameters
Workflow UUID.
Body
application/json
Response
The updated workflow.
A workflow definition and its metadata.
Example:
"draft"
Example:
"organization"
Full WorkflowDefinition (nodes, edges, state_schema, metadata).
Default input parameters.
Default execution config.
Was this page helpful?
⌘I