Update Flow
Renames and/or re-categorises a Flow that is still in DRAFT. Accepts exactly name and categories — and the omission is the guard: publishing is irreversible, so it has its own route (POST /v1/flows/{id}/publish), as does deprecating. An unknown field is REFUSED with 400 FLOW_UNKNOWN_FIELDS, never ignored. Sending neither field is 400 FLOW_PATCH_EMPTY — not a 200 over a change that never happened. Permission flows:manage.
Requires a number-scoped key. A tenant-scoped key must name the number with the x-whatsapp-number-id header, or it gets 403 TENANT_SCOPE_NOT_ALLOWED.
curl --request PATCH \
--url https://pilotstatus.com.br/v1/flows/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Agendamento (matriz)",
"categories": [
"APPOINTMENT_BOOKING"
]
}
'import requests
url = "https://pilotstatus.com.br/v1/flows/{id}"
payload = {
"name": "Agendamento (matriz)",
"categories": ["APPOINTMENT_BOOKING"]
}
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({name: 'Agendamento (matriz)', categories: ['APPOINTMENT_BOOKING']})
};
fetch('https://pilotstatus.com.br/v1/flows/{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://pilotstatus.com.br/v1/flows/{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' => 'Agendamento (matriz)',
'categories' => [
'APPOINTMENT_BOOKING'
]
]),
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://pilotstatus.com.br/v1/flows/{id}"
payload := strings.NewReader("{\n \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\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://pilotstatus.com.br/v1/flows/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/flows/{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 \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"id": "cmf1a2b3c4d5e6f7g8h9i0j1"
}{
"error": "Nada a atualizar: envie name e/ou categories.",
"errorEN": "Nothing to update: provide name and/or categories.",
"code": "FLOW_PATCH_EMPTY"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Flow não encontrado para o número desta chave.",
"errorEN": "Flow not found for this key's number.",
"code": "FLOW_NOT_FOUND"
}{
"error": "Este Flow já foi publicado na Meta e não pode mais ser alterado. Clone-o para criar uma nova versão.",
"errorEN": "This Flow is already published on Meta and can no longer be changed. Clone it to create a new version.",
"code": "FLOW_NOT_DRAFT"
}{
"error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
"errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
"code": "FLOW_REQUIRES_META_NUMBER"
}{
"error": "Too many requests"
}{
"error": "Erro interno do servidor.",
"errorEN": "Internal server error.",
"code": "INTERNAL_ERROR"
}Authorizations
Your ps_ API key
Path Parameters
The local id of the Flow — the id field GET /v1/flows returns, never metaFlowId.
Body
New name. Empty or whitespace-only is refused.
1"Agendamento (matriz)"
1SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER ["APPOINTMENT_BOOKING"]
Response
Flow updated
Was this page helpful?
curl --request PATCH \
--url https://pilotstatus.com.br/v1/flows/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Agendamento (matriz)",
"categories": [
"APPOINTMENT_BOOKING"
]
}
'import requests
url = "https://pilotstatus.com.br/v1/flows/{id}"
payload = {
"name": "Agendamento (matriz)",
"categories": ["APPOINTMENT_BOOKING"]
}
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({name: 'Agendamento (matriz)', categories: ['APPOINTMENT_BOOKING']})
};
fetch('https://pilotstatus.com.br/v1/flows/{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://pilotstatus.com.br/v1/flows/{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' => 'Agendamento (matriz)',
'categories' => [
'APPOINTMENT_BOOKING'
]
]),
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://pilotstatus.com.br/v1/flows/{id}"
payload := strings.NewReader("{\n \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\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://pilotstatus.com.br/v1/flows/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/flows/{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 \"name\": \"Agendamento (matriz)\",\n \"categories\": [\n \"APPOINTMENT_BOOKING\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"id": "cmf1a2b3c4d5e6f7g8h9i0j1"
}{
"error": "Nada a atualizar: envie name e/ou categories.",
"errorEN": "Nothing to update: provide name and/or categories.",
"code": "FLOW_PATCH_EMPTY"
}{
"error": "Unauthorized"
}{
"error": "Tenant-scoped keys cannot call number endpoints",
"code": "TENANT_SCOPE_NOT_ALLOWED"
}{
"error": "Flow não encontrado para o número desta chave.",
"errorEN": "Flow not found for this key's number.",
"code": "FLOW_NOT_FOUND"
}{
"error": "Este Flow já foi publicado na Meta e não pode mais ser alterado. Clone-o para criar uma nova versão.",
"errorEN": "This Flow is already published on Meta and can no longer be changed. Clone it to create a new version.",
"code": "FLOW_NOT_DRAFT"
}{
"error": "Flows existem apenas em números Meta (API Oficial). O número desta chave não é Meta ou não tem uma WABA associada — use uma chave de um número Meta.",
"errorEN": "Flows only exist on Meta (Cloud API) numbers. This key's number is not a Meta number, or has no WABA behind it — use a key bound to a Meta number.",
"code": "FLOW_REQUIRES_META_NUMBER"
}{
"error": "Too many requests"
}{
"error": "Erro interno do servidor.",
"errorEN": "Internal server error.",
"code": "INTERNAL_ERROR"
}