Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
broadcast
Criar lista de transmissão
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "phones": [
    {}
  ]
}
'

​
Conceituação

Neste método você pode criar uma nova lista de transmissão, definindo um nome e os números que farão parte dela.
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.

​
Obrigatórios

​
name
string
obrigatório
Nome da lista de transmissão
​
phones
array
obrigatório
Lista de números dos destinatários no formato E.164 sem o +. Ex: 5511999999999

​
Request Body

{
  "name": "Nome da lista",
  "phones": ["5511999999999", "5511888888888"]
}

​
Response

​
200

{
  "broadcastId": "1779474934@broadcast",
  "name": "Nome da lista",
  "phones": [
    "5511999999999",
    "5511888888888"
  ]
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST 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”.