Skip to main content
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": [
    {}
  ]
}
'

​
Overview

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

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
broadcastId
string
required
ID of the broadcast list to be updated. Ex: 1779474934@broadcast

​
Optional

​
name
string
New name for the broadcast list

​
Required

​
phones
array
required
Full list of recipient numbers in E.164 format without +. Ex: 5511999999999
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 the Content-Type header in your request. In most cases, the value should be application/json.