curl --request PATCH \
--url https://eu.phrase.com/orchestrator/api/v1/workflows/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Updated description",
"name": "Renamed Workflow"
}
'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/workflows/{id}"
payload = {
"description": "Updated description",
"name": "Renamed Workflow"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: 'Updated description', name: 'Renamed Workflow'})
};
fetch('https://eu.phrase.com/orchestrator/api/v1/workflows/{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://eu.phrase.com/orchestrator/api/v1/workflows/{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([
'description' => 'Updated description',
'name' => 'Renamed Workflow'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://eu.phrase.com/orchestrator/api/v1/workflows/{id}"
payload := strings.NewReader("{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://eu.phrase.com/orchestrator/api/v1/workflows/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}"
response = http.request(request)
puts response.read_body{
"deployed_revision_id": null,
"description": "Workflow created via API",
"folder_id": null,
"id": 123,
"inserted_at": "2026-01-15T09:30:00.000000Z",
"latest_revision_id": 789,
"name": "My Workflow",
"owner": {
"id": 456,
"inserted_at": "2025-11-02T10:15:00.000000Z",
"name": "Ada Lovelace",
"organization": {
"id": 42,
"inserted_at": "2025-11-01T08:00:00.000000Z",
"name": "Acme Localization",
"updated_at": "2025-11-01T08:00:00.000000Z"
},
"updated_at": "2025-11-02T10:15:00.000000Z"
},
"updated_at": "2026-01-15T09:30:00.000000Z",
"url": "https://eu.phrase.com/orchestrator/manage/workflows/123/editor/789",
"webhook_url": "https://eu.phrase.com/orchestrator/webhooks/0b7e7c1c-3f4a-4d0e-9b8f-5a2d6c9e1f30"
}Update a workflow
Renames a workflow, changes its description, or moves it to another folder. An omitted attribute is left unchanged; send null to clear description or to move the workflow to the root folder (folder_id). name can’t be cleared. The trigger and actions are changed through the workflow’s revisions instead.
curl --request PATCH \
--url https://eu.phrase.com/orchestrator/api/v1/workflows/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "Updated description",
"name": "Renamed Workflow"
}
'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/workflows/{id}"
payload = {
"description": "Updated description",
"name": "Renamed Workflow"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: 'Updated description', name: 'Renamed Workflow'})
};
fetch('https://eu.phrase.com/orchestrator/api/v1/workflows/{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://eu.phrase.com/orchestrator/api/v1/workflows/{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([
'description' => 'Updated description',
'name' => 'Renamed Workflow'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://eu.phrase.com/orchestrator/api/v1/workflows/{id}"
payload := strings.NewReader("{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://eu.phrase.com/orchestrator/api/v1/workflows/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"Updated description\",\n \"name\": \"Renamed Workflow\"\n}"
response = http.request(request)
puts response.read_body{
"deployed_revision_id": null,
"description": "Workflow created via API",
"folder_id": null,
"id": 123,
"inserted_at": "2026-01-15T09:30:00.000000Z",
"latest_revision_id": 789,
"name": "My Workflow",
"owner": {
"id": 456,
"inserted_at": "2025-11-02T10:15:00.000000Z",
"name": "Ada Lovelace",
"organization": {
"id": 42,
"inserted_at": "2025-11-01T08:00:00.000000Z",
"name": "Acme Localization",
"updated_at": "2025-11-01T08:00:00.000000Z"
},
"updated_at": "2025-11-02T10:15:00.000000Z"
},
"updated_at": "2026-01-15T09:30:00.000000Z",
"url": "https://eu.phrase.com/orchestrator/manage/workflows/123/editor/789",
"webhook_url": "https://eu.phrase.com/orchestrator/webhooks/0b7e7c1c-3f4a-4d0e-9b8f-5a2d6c9e1f30"
}Authorizations
A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.
Body
Attributes to update
Request body for updating a workflow. Omitted attributes keep their current value.
Response
OK
A workflow owned by, or shared with, the authenticated user.
URL to POST events to in order to start the workflow, or null when no revision has used a webhook trigger. New revisions keep the same URL, but it changes if the webhook key is regenerated in the editor. It accepts events only while the deployed revision has a webhook trigger.
"https://eu.phrase.com/orchestrator/webhooks/0b7e7c1c-3f4a-4d0e-9b8f-5a2d6c9e1f30"
Was this page helpful?