> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Evento

> Cria um evento (reunião/agenda) com data, local e lembrete

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Envia uma mensagem de **evento** (card de reunião/agenda) a um contato 1-a-1 ou, mais comumente, a um grupo (`@g.us`). Os campos `startAt` e `endAt` aceitam datas no formato **ISO 8601 (RFC3339)** com fuso horário (ex.: `2026-04-28T14:00:00-03:00`) e são convertidos para Unix (segundos) internamente. Opcionalmente o evento pode incluir `description`, `location`, `joinLink`, lembrete (`hasReminder` + `reminderOffsetSec`) e flags como `isScheduleCall` e `extraGuestsAllowed`. Suporta `delay`, `replyTo` e `replyPrivate`.

## Exemplos

### Reunião com local e lembrete

Cria um evento em um grupo com início e fim, local e um lembrete 15 minutos antes (`reminderOffsetSec: 900`).

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/event/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":      "120363312345678901@g.us",
      "name":        "Reunião do time",
      "description": "Planejamento do trimestre",
      "startAt":     "2026-04-28T14:00:00-03:00",
      "endAt":       "2026-04-28T16:00:00-03:00",
      "location":    { "name": "Sala 3, Sede", "address": "Av. Paulista, 1000" },
      "hasReminder":       true,
      "reminderOffsetSec": 900
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/event/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:      "120363312345678901@g.us",
      name:        "Reunião do time",
      description: "Planejamento do trimestre",
      startAt:     "2026-04-28T14:00:00-03:00",
      endAt:       "2026-04-28T16:00:00-03:00",
      location:    { name: "Sala 3, Sede", address: "Av. Paulista, 1000" },
      hasReminder:       true,
      reminderOffsetSec: 900
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/event/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":      "120363312345678901@g.us",
          "name":        "Reunião do time",
          "description": "Planejamento do trimestre",
          "startAt":     "2026-04-28T14:00:00-03:00",
          "endAt":       "2026-04-28T16:00:00-03:00",
          "location":    {"name": "Sala 3, Sede", "address": "Av. Paulista, 1000"},
          "hasReminder":       True,
          "reminderOffsetSec": 900
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":      "120363312345678901@g.us",
          "name":        "Reunião do time",
          "description": "Planejamento do trimestre",
          "startAt":     "2026-04-28T14:00:00-03:00",
          "endAt":       "2026-04-28T16:00:00-03:00",
          "location":    { "name": "Sala 3, Sede", "address": "Av. Paulista, 1000" },
          "hasReminder":       true,
          "reminderOffsetSec": 900
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/event/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Chamada agendada com link

`isScheduleCall: true` marca o evento como uma chamada e `joinLink` informa o link para entrar.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/message/event/$Instance_Name" \
    -H "token: $Token_Instance" \
    -H "Content-Type: application/json" \
    -d '{
      "number":         "120363312345678901@g.us",
      "name":           "Daily da equipe",
      "startAt":        "2026-05-04T09:00:00-03:00",
      "isScheduleCall": true,
      "joinLink":       "https://meet.example.com/daily"
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/message/event/${process.env.Instance_Name}`, {
    method: "POST",
    headers: {
      "token":        process.env.Token_Instance,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:         "120363312345678901@g.us",
      name:           "Daily da equipe",
      startAt:        "2026-05-04T09:00:00-03:00",
      isScheduleCall: true,
      joinLink:       "https://meet.example.com/daily"
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      f"https://ryzeapi.cloud/api/message/event/{os.environ['Instance_Name']}",
      headers={
          "token":        os.environ["Token_Instance"],
          "Content-Type": "application/json"
      },
      json={
          "number":         "120363312345678901@g.us",
          "name":           "Daily da equipe",
          "startAt":        "2026-05-04T09:00:00-03:00",
          "isScheduleCall": True,
          "joinLink":       "https://meet.example.com/daily"
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":         "120363312345678901@g.us",
          "name":           "Daily da equipe",
          "startAt":        "2026-05-04T09:00:00-03:00",
          "isScheduleCall": true,
          "joinLink":       "https://meet.example.com/daily"
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/message/event/"+os.Getenv("Instance_Name"), body)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

O `content` retornado é o nome do evento, usado para indexar a mensagem no histórico. Guarde o `messageId` para correlacionar respostas (going/not-going) recebidas via webhook.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Event sent successfully",
  "status":  "sent",
  "data": {
    "messageId":   "3EB08FCF27E532F1D3D3",
    "direction":   "sent",
    "messageType": "event",
    "content":     "Reunião do time",
    "source":      "api",
    "timestamp":   "2026-04-28T14:30:00Z",
    "chat": {
      "jid":     "120363312345678901@g.us",
      "isGroup": true
    },
    "sender": {
      "jid":      "5511777777777@s.whatsapp.net",
      "instance": "minha-instancia"
    }
  }
}
```

<Note>
  As confirmações de presença dos participantes não chegam síncronamente nesta resposta, elas trafegam como eventos no webhook/WebSocket configurado, referenciando o `messageId` do evento.
</Note>

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `$Instance_Name`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Destino: telefone (`5511999999999`) ou JID. Eventos funcionam melhor em grupos (`@g.us`).
</ParamField>

<ParamField body="name" type="string" required>
  Título do evento exibido no card.
</ParamField>

<ParamField body="startAt" type="string" required>
  Data/hora de início no formato **ISO 8601 (RFC3339)** com fuso, ex.: `2026-04-28T14:00:00-03:00`.
</ParamField>

<ParamField body="endAt" type="string">
  Data/hora de término no formato **ISO 8601 (RFC3339)**. Opcional.
</ParamField>

<ParamField body="description" type="string">
  Descrição/detalhes do evento.
</ParamField>

<ParamField body="location" type="object">
  Local do evento. Campos: `name`, `address`, `latitude`, `longitude` (todos opcionais).
</ParamField>

<ParamField body="joinLink" type="string">
  Link para entrar (usado em chamadas agendadas).
</ParamField>

<ParamField body="isScheduleCall" type="boolean" default="false">
  Marca o evento como uma chamada agendada.
</ParamField>

<ParamField body="hasReminder" type="boolean" default="false">
  Habilita um lembrete para o evento.
</ParamField>

<ParamField body="reminderOffsetSec" type="int" default="0">
  Antecedência do lembrete, em **segundos** antes do `startAt` (ex.: `900` = 15 min).
</ParamField>

<ParamField body="extraGuestsAllowed" type="boolean" default="false">
  Permite que convidados tragam acompanhantes.
</ParamField>

<ParamField body="isCanceled" type="boolean" default="false">
  Marca o evento como cancelado.
</ParamField>

<ParamField body="delay" type="int" default="0">
  Tempo em **segundos** para aguardar antes de enviar. Durante o intervalo, o servidor envia o indicador de "digitando..." ao destinatário e dispara o "paused" antes do envio real.
</ParamField>

<ParamField body="replyTo" type="string">
  ID da mensagem a ser citada (reply). A mensagem original precisa pertencer à mesma instância e ter sido salva no banco.
</ParamField>

<ParamField body="replyPrivate" type="boolean" default="false">
  Quando `true` **e** `replyTo` aponta para uma mensagem originária de um grupo, o evento é redirecionado para o **privado** do autor original (mantendo a citação).
</ParamField>

<ParamField body="source" type="string" default="api">
  Identificador de origem para rastreabilidade (ex.: `crm`, `bot-suporte`, `n8n`). Salvo no registro da mensagem e propagado para webhooks.
</ParamField>

## Notas

<Note>
  * **`startAt`/`endAt` são ISO 8601 (RFC3339)** com fuso horário; o servidor converte para Unix (segundos).
  * **`delay` é em segundos** (não milissegundos); **`reminderOffsetSec` também é em segundos**.
  * Eventos são exibidos melhor em **grupos** (`@g.us`).
  * As confirmações de presença não voltam nesta chamada, assine os eventos do webhook/WebSocket para recebê-las referenciando o `messageId`.
</Note>

## Erros

| HTTP | Status interno    | Mensagem                                                  |
| ---- | ----------------- | --------------------------------------------------------- |
| 400  | ,                 | `Instance name is required`                               |
| 400  | ,                 | `Invalid request body: <detalhe>`                         |
| 400  | ,                 | `Number is required`                                      |
| 400  | ,                 | `Name is required`                                        |
| 400  | ,                 | `startAt is required`                                     |
| 400  | `invalid_request` | `Invalid startAt, expected ISO 8601 (RFC3339): <detalhe>` |
| 400  | `invalid_number`  | `Invalid phone number format: <detalhe>`                  |
| 404  | ,                 | `Instance not found`                                      |
| 500  | `send_failed`     | `Failed to send event: <reason>`                          |
| 503  | `disconnected`    | `Instance is not connected to WhatsApp`                   |

Envelope de erro:

```json theme={null}
{
  "success": false,
  "error": { "message": "startAt is required" }
}
```
