Editar lista de transmissão
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId} \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phones": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}"
payload = { "phones": [{}] }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}', 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.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}",
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([
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"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.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}"
payload := strings.NewReader("{\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Client-Token", "<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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyTransmission List
Editar lista de transmissão
Edita uma lista de transmissão existente no WhatsApp
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
broadcast
/
{broadcastId}
Editar lista de transmissão
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId} \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"phones": [
{}
]
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}"
payload = { "phones": [{}] }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({phones: [{}]})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}', 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.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}",
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([
'phones' => [
[
]
]
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"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.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}"
payload := strings.NewReader("{\n \"phones\": [\n {}\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Client-Token", "<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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phones\": [\n {}\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast/{broadcastId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phones\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_bodyConceituação
Neste método você pode editar uma lista de transmissão já existente, alterando o nome e/ou os números que a compõem.Atente-se às limitações e regras do uso de listas de transmissão. Para mais detalhes, consulte a introdução.
Atributos
Header
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.
Path
string
obrigatório
ID da lista de broadcast a ser editada. Ex: 1779474934@broadcast
Opcionais
string
Novo nome da lista de transmissão
Obrigatórios
array
obrigatório
Lista completa de números dos destinatários no formato E.164 sem o
+. Ex: 5511999999999O campo
phones substitui a lista atual por completo a cada requisição. Por isso:- Para adicionar um novo contato, envie todos os números já existentes na lista mais o novo.
- Para remover um contato, envie todos os números existentes, omitindo apenas os que deseja remover.
Request Body
{
"name": "Nome da lista",
"phones": ["5511999999999", "5511888888888"]
}
Response
200
{
"broadcastId": "1778158856@broadcast",
"name": "Teste de broadcast editado",
"phones": [
"5511999999999",
"5511888888888",
"5511777777777"
]
}