Update broadcast list
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
Update broadcast list
Updates an existing broadcast list
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
broadcast
/
{broadcastId}
Update broadcast list
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_bodyOverview
This method allows you to update an existing broadcast list, changing its name and/or the numbers it contains.Please be aware of the limitations and rules around the use of broadcast lists. For more details, check the introduction.
Attributes
Header
Path
Optional
Required
The
phones field completely replaces the current list on every request. Therefore:- To add a contact, send all existing numbers along with the new one.
- To remove a contact, send all existing numbers, omitting only the ones you want to remove.
Request Body
{
"name": "List name",
"phones": ["5511999999999", "5511888888888"]
}
Response
200
{
"broadcastId": "1778158856@broadcast",
"name": "Updated broadcast list",
"phones": [
"5511999999999",
"5511888888888",
"5511777777777"
]
}
405
Make sure you are sending the request with the correct HTTP method. Check that you are using PUT as specified at the top of this page.415
If you receive a 415 error, make sure to include theContent-Type header in your request. In most cases, the value should be application/json.