Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
send-event
Enviar evento
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-event \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "event": {
    "name": "<string>",
    "dateTime": "<string>",
    "description": "<string>",
    "timeZone": "<string>",
    "location": {
      "name": "<string>"
    },
    "callLinkType": "<string>",
    "canceled": true
  }
}
'

​
Conceituação

Neste método você poderá enviar mensagens do tipo Evento.
Só é possível enviar esse tipo de mensagem para um grupo.

​
Exemplo no WhatsApp

​
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

​
phone
string
obrigatório
ID do grupo destinatário
​
event
object
obrigatório
Dados do evento

​
Request Body

{
  "phone": "120363019502650977-group",
  "event": {
    "name": "Nome do evento",
    "description": "Descrição do evento",
    "dateTime": "2024-04-29T09:30:53.309Z",
    "timeZone": "UTC-3",
    "location": {
      "name": "Nome do lugar"
    },
    "callLinkType": "voice",
    "canceled": false
  }
}

​
Response

​
200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

​
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”.