Pular para o conteúdo principal
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": [
    {}
  ]
}
'

​
Conceituaçã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

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Path

​
broadcastId
string
obrigatório
ID da lista de broadcast a ser editada. Ex: 1779474934@broadcast

​
Opcionais

​
name
string
Novo nome da lista de transmissão

​
Obrigatórios

​
phones
array
obrigatório
Lista completa de números dos destinatários no formato E.164 sem o +. Ex: 5511999999999
O 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"
  ]
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.