Atualizar flow
curl --request PUT \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "agendamento_consulta_v2"
}
'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}"
payload = { "name": "agendamento_consulta_v2" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'agendamento_consulta_v2'})
};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}', 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.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'agendamento_consulta_v2'
]),
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://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}"
payload := strings.NewReader("{\n \"name\": \"agendamento_consulta_v2\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"agendamento_consulta_v2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"agendamento_consulta_v2\"\n}"
response = http.request(request)
puts response.read_body{
"id": "1122334455667788",
"name": "agendamento_consulta",
"categories": [
"APPOINTMENT_BOOKING"
],
"status": "PUBLISHED",
"endpoint_uri": null,
"validation_errors": []
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Flows (WhatsApp)
Atualizar flow
Altere nome, categorias ou o flow_json
PUT
/
whatsapp
/
businesses
/
{wabaId}
/
flows
/
{flowId}
Atualizar flow
curl --request PUT \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "agendamento_consulta_v2"
}
'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}"
payload = { "name": "agendamento_consulta_v2" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'agendamento_consulta_v2'})
};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}', 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.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'agendamento_consulta_v2'
]),
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://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}"
payload := strings.NewReader("{\n \"name\": \"agendamento_consulta_v2\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"agendamento_consulta_v2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/flows/{flowId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"agendamento_consulta_v2\"\n}"
response = http.request(request)
puts response.read_body{
"id": "1122334455667788",
"name": "agendamento_consulta",
"categories": [
"APPOINTMENT_BOOKING"
],
"status": "PUBLISHED",
"endpoint_uri": null,
"validation_errors": []
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Conceituação
Atualiza um flow existente. Todos os campos são opcionais — apenas os enviados são alterados.Um flow
PUBLISHED não aceita alteração do flow_json. Para mudar as telas de um flow já publicado, crie um novo e descontinue o antigo com Descontinuar flow.Autorizações
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Parâmetros de caminho
ID do WABA (obtido via Listar WABAs)
Exemplo:
"428083093730937"
ID do flow (obtido via Listar flows)
Exemplo:
"1122334455667788"
Corpo
application/json
Nome do flow
Categorias do flow (a Meta usa na revisão)
Opções disponíveis:
SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER Definição das telas em JSON, enviada como string
URL do seu endpoint, obrigatória apenas para flows com data_exchange
Resposta
Flow atualizado
ID do flow
Nome do flow
Categorias do flow (a Meta usa na revisão)
Opções disponíveis:
SIGN_UP, SIGN_IN, APPOINTMENT_BOOKING, LEAD_GENERATION, CONTACT_US, CUSTOMER_SUPPORT, SURVEY, OTHER Status de publicação
Opções disponíveis:
DRAFT, PUBLISHED, DEPRECATED, BLOCKED, THROTTLED URL do seu endpoint, obrigatória apenas para flows com data_exchange
Definição das telas em JSON, enviada como string
Pendências de validação devolvidas pela Meta
Show child attributes
Show child attributes